Type-erased base for a zero-dimensional solve, exposing output and config entry points. More...

#include <zero_dim_solve.hpp>

Inheritance diagram for bertini::algorithm::AnyZeroDim:

Collaboration diagram for bertini::algorithm::AnyZeroDim:

Public Member Functions
virtual void	WriteMainData (std::ostream &out) const =0
	Write the human-readable main-data report to `out`.
virtual void	WriteRawData (std::ostream &out) const =0
	Write the raw-data report to `out`.
virtual void	WriteFiniteSolutions (std::ostream &out) const =0
	Write the finite solutions (Bertini 1.7 format) to `out`.
virtual void	WriteRealFiniteSolutions (std::ostream &out) const =0
	Write the real finite solutions (Bertini 1.7 format) to `out`.
virtual void	WriteNonsingularSolutions (std::ostream &out) const =0
	Write the nonsingular solutions (Bertini 1.7 format) to `out`.
virtual void	WriteSingularSolutions (std::ostream &out) const =0
	Write the singular solutions (Bertini 1.7 format) to `out`.
virtual void	WriteRawSolutions (std::ostream &out) const =0
	Write the raw solutions (Bertini 1.7 format) to `out`.
virtual void	ApplyParsedConfigs (std::string const &config_str)=0
	Apply configuration settings parsed from a classic-input config string.
virtual void	RecordToPath (std::string const &)
	Attach a structured output directory at `path` (records + resume; ADR-0046).
virtual std::string	RecordsRunIdentity () const
	This solve's run id in the records (empty when not recording).
virtual void	AppendRecordJson (std::string const &)
	Append one raw record (a JSON object as text) to the attached directory; no-op when not recording.
virtual std::string	PutRecordsDefinition (std::string const &, std::string const &, std::string const &={})
	Store content as a definition of the given kind ("systems"/"configs"/ "givens"), optionally labeled by role in the filename (e.g.
virtual	~AnyZeroDim ()=default
virtual void	Run ()=0
	Run the algorithm.
void	AddObserver (AnyObserver &new_observer) const
	Add an observer (non-owning) to observe this observable.
void	AddObserver (std::shared_ptr< AnyObserver > const &new_observer) const
	Add an observer whose lifetime is co-owned by this observable.
void	RemoveObserver (AnyObserver &observer) const
	Remove an observer from this observable.
virtual bool	ObservableIsA (std::type_index t) const
	Whether this observable may be observed as the given type.

Protected Member Functions
void	NotifyObservers (AnyEvent const &e) const
	Sends an event to observers that subscribed to its exact dynamic type, then to all catch-all (untyped) observers.
void	NotifyObservers (AnyEvent &e) const
	Notify all observers of a (mutable) event.
bool	HasObservers () const
	Whether anyone is currently observing (conservative).

Detailed Description

Type-erased base for a zero-dimensional solve, exposing output and config entry points.

Constructor & Destructor Documentation

◆ ~AnyZeroDim()

virtual bertini::algorithm::AnyZeroDim::~AnyZeroDim ( )

virtualdefault

Member Function Documentation

◆ AddObserver() [1/2]

void bertini::Observable::AddObserver ( AnyObserver & new_observer ) const

inlineinherited

Add an observer (non-owning) to observe this observable.

Stores only a raw reference: the caller is responsible for keeping the observer alive while it is attached. This is the right overload for stack-allocated C++ observers added and removed within a scope. For an observer whose lifetime you would rather have tracked, see the shared_ptr overload.

Observers that override SubscribedEventTypes() with a non-empty list are registered in a type-indexed map so NotifyObservers only calls them for events they declared interest in. Observers returning an empty list (the default) are placed in a catch-all list and receive every event.

Safe to call from inside an observer's Observe() (i.e. during a notification): the add is deferred and applied once the current notification loop finishes. This is what lets a "meta-observer" attach new observers in response to events.

Exceptions

IncompatibleObserver if the observer's ObservedKind() is not one this observable can be observed as.

◆ AddObserver() [2/2]

void bertini::Observable::AddObserver ( std::shared_ptr< AnyObserver > const & new_observer ) const

inlineinherited

Add an observer whose lifetime is co-owned by this observable.

The observable keeps a shared_ptr, so the observer stays alive (and keeps receiving events) for as long as it is attached, even after the caller drops their own reference — "attach it and forget it", with no dangling. It is released when RemoveObserver is called or this observable is destroyed. (Stack-allocated C++ observers can't be shared_ptr-owned; use the reference overload for those.)

Exceptions

IncompatibleObserver if incompatible (see the reference overload).

◆ AppendRecordJson()

virtual void bertini::algorithm::AnyZeroDim::AppendRecordJson ( std::string const & )

inlinevirtual

Append one raw record (a JSON object as text) to the attached directory; no-op when not recording.

Lets the CLI archive its input file as a given.

Reimplemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ ApplyParsedConfigs()

virtual void bertini::algorithm::AnyZeroDim::ApplyParsedConfigs ( std::string const & config_str )

pure virtual

Apply configuration settings parsed from a classic-input config string.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ HasObservers()

bool bertini::Observable::HasObservers ( ) const

inlineprotectedinherited

Whether anyone is currently observing (conservative).

Lets an emitter skip constructing an event – and any work needed to build its payload, such as a numeric-type conversion – when there is no observer to receive it. Conservative: returns true if any watcher list is non-empty (even if a stale, emptied typed bucket lingers), so it never wrongly suppresses a real observer.

◆ NotifyObservers() [1/2]

void bertini::Observable::NotifyObservers ( AnyEvent & e ) const

inlineprotectedinherited

Notify all observers of a (mutable) event.

◆ NotifyObservers() [2/2]

void bertini::Observable::NotifyObservers ( AnyEvent const & e ) const

inlineprotectedinherited

Sends an event to observers that subscribed to its exact dynamic type, then to all catch-all (untyped) observers.

Mutations of the observer lists are deferred for the duration of a notification (see AddObserver/RemoveObserver), so iterating the live lists here is safe even when an observer subscribes/unsubscribes mid-dispatch. An observer that returns ObserveResult::Unsubscribe is dropped once the (possibly nested) notification completes. The depth counter keeps this correct under re-entrant emission.

◆ ObservableIsA()

virtual bool bertini::Observable::ObservableIsA ( std::type_index t ) const

inlinevirtualinherited

Whether this observable may be observed as the given type.

Drives the compatibility check in AddObserver. The default accepts the wildcard typeid(void) and this observable's own dynamic type. An observable that emits its events templated on a base type (so a single observer type serves many concrete observables) should also accept that base type — e.g. ZeroDim accepts AnyZeroDim.

Reimplemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ PutRecordsDefinition()

virtual std::string bertini::algorithm::AnyZeroDim::PutRecordsDefinition	(	std::string const &	,
		std::string const &	,
		std::string const &	= {} )

inlinevirtual

Store content as a definition of the given kind ("systems"/"configs"/ "givens"), optionally labeled by role in the filename (e.g.

"cli_input"), in the attached directory; returns its id (empty when not recording).

Reimplemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ RecordsRunIdentity()

virtual std::string bertini::algorithm::AnyZeroDim::RecordsRunIdentity ( ) const

inlinevirtual

This solve's run id in the records (empty when not recording).

Reimplemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ RecordToPath()

virtual void bertini::algorithm::AnyZeroDim::RecordToPath ( std::string const & )

inlinevirtual

Attach a structured output directory at path (records + resume; ADR-0046).

Default no-op so non-recording derivers are unaffected; HomotopySolver overrides.

Reimplemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ RemoveObserver()

void bertini::Observable::RemoveObserver ( AnyObserver & observer ) const

inlineinherited

Remove an observer from this observable.

Like AddObserver, this is safe to call during a notification: the removal is deferred until the current notification loop finishes.

◆ Run()

virtual void bertini::algorithm::AnyAlgorithm::Run ( )

pure virtualinherited

Run the algorithm.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, bertini::algorithm::HomotopySolver< A, B, C >, and bertini::algorithm::NumericalIrreducibleDecomposition< TrackerType, EndgameType, SystemType >.

◆ WriteFiniteSolutions()

virtual void bertini::algorithm::AnyZeroDim::WriteFiniteSolutions ( std::ostream & out ) const

pure virtual

Write the finite solutions (Bertini 1.7 format) to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ WriteMainData()

virtual void bertini::algorithm::AnyZeroDim::WriteMainData ( std::ostream & out ) const

pure virtual

Write the human-readable main-data report to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ WriteNonsingularSolutions()

virtual void bertini::algorithm::AnyZeroDim::WriteNonsingularSolutions ( std::ostream & out ) const

pure virtual

Write the nonsingular solutions (Bertini 1.7 format) to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ WriteRawData()

virtual void bertini::algorithm::AnyZeroDim::WriteRawData ( std::ostream & out ) const

pure virtual

Write the raw-data report to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ WriteRawSolutions()

virtual void bertini::algorithm::AnyZeroDim::WriteRawSolutions ( std::ostream & out ) const

pure virtual

Write the raw solutions (Bertini 1.7 format) to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ WriteRealFiniteSolutions()

virtual void bertini::algorithm::AnyZeroDim::WriteRealFiniteSolutions ( std::ostream & out ) const

pure virtual

Write the real finite solutions (Bertini 1.7 format) to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

◆ WriteSingularSolutions()

virtual void bertini::algorithm::AnyZeroDim::WriteSingularSolutions ( std::ostream & out ) const

pure virtual

Write the singular solutions (Bertini 1.7 format) to out.

Implemented in bertini::algorithm::HomotopySolver< TrackerType, EndgameType, SystemType >, and bertini::algorithm::HomotopySolver< A, B, C >.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~AnyZeroDim()

Member Function Documentation

◆ AddObserver() [1/2]

◆ AddObserver() [2/2]

◆ AppendRecordJson()

◆ ApplyParsedConfigs()

◆ HasObservers()

◆ NotifyObservers() [1/2]

◆ NotifyObservers() [2/2]

◆ ObservableIsA()

◆ PutRecordsDefinition()

◆ RecordsRunIdentity()

◆ RecordToPath()

◆ RemoveObserver()

◆ Run()

◆ WriteFiniteSolutions()

◆ WriteMainData()

◆ WriteNonsingularSolutions()

◆ WriteRawData()

◆ WriteRawSolutions()

◆ WriteRealFiniteSolutions()

◆ WriteSingularSolutions()