Bertini 2 d882924 (2026-10-06 19:56 UTC)
Numerical algebraic geometry library (C++ core)
Loading...
Searching...
No Matches
bertini::endgame::ComputedSamplePoint< ObservedT > Class Template Reference

A new sample point on the path was computed, adding one point to the sequence of the endgame's approach to the target time. More...

#include <events.hpp>

Inheritance diagram for bertini::endgame::ComputedSamplePoint< ObservedT >:
[legend]
Collaboration diagram for bertini::endgame::ComputedSamplePoint< ObservedT >:
[legend]

Public Types

using ComplexT = typename ObservedT::BaseComplexT
 The complex number type.

Public Member Functions

 ComputedSamplePoint (const ObservedT &obs, Vec< ComplexT > const &new_point, ComplexT const &new_time)
 The constructor for a ComputedSamplePoint event.
virtual ~ComputedSamplePoint ()=default
 ComputedSamplePoint ()=delete
const auto & NewSample () const
const auto & NewTime () const

Detailed Description

template<class ObservedT>
class bertini::endgame::ComputedSamplePoint< ObservedT >

A new sample point on the path was computed, adding one point to the sequence of the endgame's approach to the target time.

Emitted by BOTH endgame flavors, wherever a new path sample becomes final: the power series endgame's time advance (after the new sample is refined), and the Cauchy endgame's rotation onto its power-series window (as tracked – Cauchy does not refine at that site). Together the emissions form a time-indexed sequence of points approaching the root, which is what lets a consumer watch a derived quantity – the singular values of a Jacobian, say – behave as a function of distance to the root, rather than thresholding it at a single point.

The sample and its time ride ON the event, as with CircleAdvanced, so an observer never has to know which flavor emitted it: the two flavors keep their samples in differently-named containers (GetSamples() versus GetPSEGSamples()).

Distinct from TimeAdvanced, which announces only that time moved and carries no payload, and from SampleRefined, which fires once per EXISTING sample when the whole window is re-refined rather than once per new sample.

Member Typedef Documentation

◆ ComplexT

template<class ObservedT>
using bertini::endgame::ComputedSamplePoint< ObservedT >::ComplexT = typename ObservedT::BaseComplexT

The complex number type.

Constructor & Destructor Documentation

◆ ComputedSamplePoint() [1/2]

template<class ObservedT>
bertini::endgame::ComputedSamplePoint< ObservedT >::ComputedSamplePoint ( const ObservedT & obs,
Vec< ComplexT > const & new_point,
ComplexT const & new_time )
inline

The constructor for a ComputedSamplePoint event.

Parameters
obsThe observable emitting the event.
new_pointThe newly computed sample point on the path.
new_timeThe time value at which the sample was computed.

◆ ~ComputedSamplePoint()

template<class ObservedT>
virtual bertini::endgame::ComputedSamplePoint< ObservedT >::~ComputedSamplePoint ( )
virtualdefault

◆ ComputedSamplePoint() [2/2]

template<class ObservedT>
bertini::endgame::ComputedSamplePoint< ObservedT >::ComputedSamplePoint ( )
delete

Member Function Documentation

◆ NewSample()

template<class ObservedT>
const auto & bertini::endgame::ComputedSamplePoint< ObservedT >::NewSample ( ) const
inline
Returns
The newly computed sample point on the path.

◆ NewTime()

template<class ObservedT>
const auto & bertini::endgame::ComputedSamplePoint< ObservedT >::NewTime ( ) const
inline
Returns
The time value at which the sample was computed.