qpe::QuantumRevivalHistory2D Class Reference

Implements the Quantum Revival History2D component. More...

#include <quantumrevivals2d.h>

Public Member Functions
	QuantumRevivalHistory2D (std::size_t maximumSamples=1200u)
	Constructs a Quantum Revival History 2D instance.
void	clear () noexcept
	Clears stored state and returns the component to its empty/default state.
bool	captureReference (const ComplexField2D &field)
	Carries out capture reference.
bool	hasReference () const noexcept
	Returns whether reference.
void	setMaximumSamples (std::size_t maximumSamples)
	Sets maximum samples.
std::size_t	maximumSamples () const noexcept
	Carries out maximum samples.
bool	append (double time, const ComplexField2D &field)
	Carries out append.
const std::vector< QuantumRevivalSample2D > &	samples () const noexcept
	Samples s.
std::size_t	size () const noexcept
	Returns size.
bool	empty () const noexcept
	Returns whether the object contains no data.
float	dx () const noexcept
	Returns the X-axis grid spacing.
std::size_t	gridWidth () const noexcept
	Carries out grid width.

Private Member Functions
void	trimToLimit ()
	Carries out trim to limit.

Private Attributes
std::size_t	maximumSamples_ = 1200u
ComplexField2D	reference_
std::vector< QuantumRevivalSample2D >	samples_

Detailed Description

Implements the Quantum Revival History2D component.

The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.

Definition at line 132 of file quantumrevivals2d.h.

Constructor & Destructor Documentation

QuantumRevivalHistory2D()

qpe::QuantumRevivalHistory2D::QuantumRevivalHistory2D ( std::size_t maximumSamples = 1200u )

explicit

Constructs a Quantum Revival History 2D instance.

Parameters

maximumSamples

The maximum samples value used by the operation.

Definition at line 204 of file quantumrevivals2d.cpp.

References maximumSamples_, and samples_.

Member Function Documentation

append()

bool qpe::QuantumRevivalHistory2D::append	(	double	time,
		const ComplexField2D &	field )

Carries out append.

Parameters

time	Simulation time in solver units.
field	Field data to read or modify.

Definition at line 236 of file quantumrevivals2d.cpp.

References qpe::ComplexField2D::empty(), qpe::QuantumRevivals2D::fidelity(), hasReference(), qpe::ComplexField2D::height(), qpe::QuantumRevivals2D::marginalProbabilityX(), reference_, samples_, trimToLimit(), and qpe::ComplexField2D::width().

Referenced by MainWindow::recordTimeSeriesSample(), and qpe::tests::runQuantumRevivals2DTests().

captureReference()

bool qpe::QuantumRevivalHistory2D::captureReference

(

const ComplexField2D &

field

)

Carries out capture reference.

Parameters

field

Field data to read or modify.

Definition at line 216 of file quantumrevivals2d.cpp.

References qpe::ComplexField2D::clear(), clear(), qpe::ComplexField2D::empty(), reference_, and samples_.

Referenced by MainWindow::resetSimulation(), and qpe::tests::runQuantumRevivals2DTests().

clear()

void qpe::QuantumRevivalHistory2D::clear ( )

noexcept

Clears stored state and returns the component to its empty/default state.

Definition at line 210 of file quantumrevivals2d.cpp.

References reference_, and samples_.

Referenced by captureReference(), and MainWindow::resetSimulation().

dx()

float qpe::QuantumRevivalHistory2D::dx ( ) const

inlinenoexcept

Returns the X-axis grid spacing.

Parameters

dx	The dx value used by the operation.

Definition at line 195 of file quantumrevivals2d.h.

References qpe::ComplexField2D::dx(), and reference_.

Referenced by QuantumRevivalPlotWidget::paintEvent().

empty()

bool qpe::QuantumRevivalHistory2D::empty ( ) const

inlinenoexcept

Returns whether the object contains no data.

Parameters

empty

The empty value used by the operation.

Definition at line 190 of file quantumrevivals2d.h.

References samples_.

Referenced by QuantumRevivalPlotWidget::paintEvent(), and MainWindow::updateRevivalAnalysis().

gridWidth()

std::size_t qpe::QuantumRevivalHistory2D::gridWidth ( ) const

inlinenoexcept

Carries out grid width.

Parameters

width

The width value used by the operation.

Definition at line 200 of file quantumrevivals2d.h.

References reference_, and qpe::ComplexField2D::width().

Referenced by QuantumRevivalPlotWidget::paintEvent().

hasReference()

bool qpe::QuantumRevivalHistory2D::hasReference ( ) const

inlinenoexcept

Returns whether reference.

Parameters

empty

The empty value used by the operation.

Definition at line 154 of file quantumrevivals2d.h.

References qpe::ComplexField2D::empty(), and reference_.

Referenced by append(), MainWindow::recordTimeSeriesSample(), and MainWindow::updateRevivalAnalysis().

maximumSamples()

std::size_t qpe::QuantumRevivalHistory2D::maximumSamples ( ) const

inlinenoexcept

Carries out maximum samples.

Definition at line 164 of file quantumrevivals2d.h.

References maximumSamples_.

Referenced by setMaximumSamples().

samples()

const std::vector< QuantumRevivalSample2D > & qpe::QuantumRevivalHistory2D::samples ( ) const

inlinenoexcept

Samples s.

Definition at line 176 of file quantumrevivals2d.h.

References samples_.

Referenced by QuantumRevivalPlotWidget::paintEvent(), qpe::tests::runQuantumRevivals2DTests(), and MainWindow::updateRevivalAnalysis().

setMaximumSamples()

void qpe::QuantumRevivalHistory2D::setMaximumSamples

(

std::size_t

maximumSamples

)

Sets maximum samples.

Parameters

maximumSamples

The maximum samples value used by the operation.

Definition at line 227 of file quantumrevivals2d.cpp.

References maximumSamples(), maximumSamples_, and trimToLimit().

size()

std::size_t qpe::QuantumRevivalHistory2D::size ( ) const

inlinenoexcept

Returns size.

Parameters

size	The size value used by the operation.

Definition at line 185 of file quantumrevivals2d.h.

References samples_.

Referenced by qpe::tests::runQuantumRevivals2DTests().

trimToLimit()

void qpe::QuantumRevivalHistory2D::trimToLimit ( )

private

Carries out trim to limit.

Definition at line 252 of file quantumrevivals2d.cpp.

References maximumSamples_, and samples_.

Referenced by append(), and setMaximumSamples().

Member Data Documentation

maximumSamples_

std::size_t qpe::QuantumRevivalHistory2D::maximumSamples_ = 1200u

private

Definition at line 208 of file quantumrevivals2d.h.

Referenced by QuantumRevivalHistory2D(), maximumSamples(), setMaximumSamples(), and trimToLimit().

reference_

ComplexField2D qpe::QuantumRevivalHistory2D::reference_

private

Definition at line 209 of file quantumrevivals2d.h.

Referenced by append(), captureReference(), clear(), dx(), gridWidth(), and hasReference().

samples_

std::vector<QuantumRevivalSample2D> qpe::QuantumRevivalHistory2D::samples_

private

Definition at line 210 of file quantumrevivals2d.h.

Referenced by QuantumRevivalHistory2D(), append(), captureReference(), clear(), empty(), samples(), size(), and trimToLimit().

---

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

• core/quantum/quantumrevivals2d.h
• core/quantum/quantumrevivals2d.cpp