Accumulators::TimeSeries Class Reference

Record values of an observable. More...

#include <TimeSeries.hpp>

Inheritance diagram for Accumulators::TimeSeries:

Collaboration diagram for Accumulators::TimeSeries:

Public Member Functions
	TimeSeries (::System::System const *system, int delta_N, std::shared_ptr< Observables::Observable > obs)
void	update (boost::mpi::communicator const &comm) override
std::string	get_internal_state () const final
void	set_internal_state (std::string const &) final
const std::vector< std::vector< double > > &	time_series () const
std::vector< std::size_t >	shape () const override
void	clear ()
Public Member Functions inherited from Accumulators::AccumulatorBase
	AccumulatorBase (::System::System const *system, int delta_N)
virtual	~AccumulatorBase ()=default
int &	delta_N ()
bool	has_same_system_handle (::System::System const *system) const
void	override_system_handle (::System::System const *system)

Additional Inherited Members
Protected Attributes inherited from Accumulators::AccumulatorBase
void const *	m_system
	for bookkeeping purposes

Detailed Description

Record values of an observable.

This is a very simple accumulator that stores the current value of an observable every time it is updated.

Definition at line 41 of file core/accumulators/TimeSeries.hpp.

Constructor & Destructor Documentation

TimeSeries()

Accumulators::TimeSeries::TimeSeries ( ::System::System const *  system, int  delta_N, std::shared_ptr< Observables::Observable >  obs  )

inline

Definition at line 43 of file core/accumulators/TimeSeries.hpp.

Member Function Documentation

clear()

void Accumulators::TimeSeries::clear ( )

inline

Definition at line 58 of file core/accumulators/TimeSeries.hpp.

get_internal_state()

std::string Accumulators::TimeSeries::get_internal_state ( ) const

finalvirtual

Implements Accumulators::AccumulatorBase.

Definition at line 39 of file TimeSeries.cpp.

set_internal_state()

void Accumulators::TimeSeries::set_internal_state ( std::string const &  state )

finalvirtual

Implements Accumulators::AccumulatorBase.

Definition at line 48 of file TimeSeries.cpp.

References Accumulators::AccumulatorBase::m_system.

shape()

std::vector< std::size_t > Accumulators::TimeSeries::shape ( ) const

inlineoverridevirtual

Implements Accumulators::AccumulatorBase.

Definition at line 52 of file core/accumulators/TimeSeries.hpp.

References shape().

Referenced by shape().

time_series()

const std::vector< std::vector< double > > & Accumulators::TimeSeries::time_series ( ) const

inline

Definition at line 51 of file core/accumulators/TimeSeries.hpp.

update()

void Accumulators::TimeSeries::update ( boost::mpi::communicator const &  comm )

overridevirtual

Implements Accumulators::AccumulatorBase.

Definition at line 31 of file TimeSeries.cpp.

---

The documentation for this class was generated from the following files:

• core/accumulators/TimeSeries.hpp
• TimeSeries.cpp