qpe::QuantumHallEdgeHistory2D Class Reference

Implements the Quantum Hall Edge History2D component. More...

#include <quantumhalledge2d.h>

Public Member Functions
	QuantumHallEdgeHistory2D (std::size_t maximumSamples=360u)
	Constructs a Quantum Hall Edge History 2D instance.
void	clear ()
	Clears stored state and returns the component to its empty/default state.
bool	configure (const ComplexField2D &field, const QuantumHallEdge2DConfig &config)
	Returns configure.
void	append (double time, const ComplexField2D &field)
	Carries out append.
bool	configured () const noexcept
	Returns configured.
bool	empty () const noexcept
	Returns whether the object contains no data.
const QuantumHallEdge2DConfig &	config () const noexcept
	Returns config.
const std::vector< QuantumHallEdgeSample2D > &	samples () const noexcept
	Samples s.

Private Member Functions
void	trim ()
	Carries out trim.

Private Attributes
bool	configured_ = false
QuantumHallEdge2DConfig	config_
double	startMeanX_ = 0.0
std::size_t	maximumSamples_ = 360u
std::vector< QuantumHallEdgeSample2D >	samples_

Detailed Description

Implements the Quantum Hall Edge 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 144 of file quantumhalledge2d.h.

Constructor & Destructor Documentation

QuantumHallEdgeHistory2D()

qpe::QuantumHallEdgeHistory2D::QuantumHallEdgeHistory2D ( std::size_t maximumSamples = 360u )

inlineexplicit

Constructs a Quantum Hall Edge History 2D instance.

Parameters

maximumSamples

The maximum samples value used by the operation.

Definition at line 151 of file quantumhalledge2d.h.

Member Function Documentation

append()

void qpe::QuantumHallEdgeHistory2D::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 203 of file quantumhalledge2d.cpp.

References config_, configured_, qpe::ComplexField2D::empty(), qpe::QuantumHallEdge2D::measure(), samples_, startMeanX_, and trim().

Referenced by MainWindow::advanceSimulation(), MainWindow::resetSimulation(), qpe::tests::anonymous_namespace{quantumhalledge2d_tests.cpp}::runOne(), and MainWindow::singleStep().

clear()

void qpe::QuantumHallEdgeHistory2D::clear

(

)

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

Definition at line 190 of file quantumhalledge2d.cpp.

References config_, configured_, samples_, and startMeanX_.

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

config()

const QuantumHallEdge2DConfig & qpe::QuantumHallEdgeHistory2D::config ( ) const

inlinenoexcept

Returns config.

Definition at line 184 of file quantumhalledge2d.h.

References config_.

Referenced by configure(), and QuantumHallEdgePlotWidget::paintEvent().

configure()

bool qpe::QuantumHallEdgeHistory2D::configure	(	const ComplexField2D &	field,
		const QuantumHallEdge2DConfig &	config )

Returns configure.

Parameters

field	Field data to read or modify.
config	Configuration to apply.

Definition at line 195 of file quantumhalledge2d.cpp.

References clear(), config(), config_, configured_, qpe::ComplexField2D::empty(), startMeanX_, and qpe::QuantumHallEdge2D::validateConfig().

Referenced by MainWindow::resetSimulation(), and qpe::tests::anonymous_namespace{quantumhalledge2d_tests.cpp}::runOne().

configured()

bool qpe::QuantumHallEdgeHistory2D::configured ( ) const

inlinenoexcept

Returns configured.

Definition at line 175 of file quantumhalledge2d.h.

References configured_.

Referenced by MainWindow::advanceSimulation(), QuantumHallEdgePlotWidget::paintEvent(), MainWindow::singleStep(), and MainWindow::updateQuantumHallEdgeAnalysis().

empty()

bool qpe::QuantumHallEdgeHistory2D::empty ( ) const

inlinenoexcept

Returns whether the object contains no data.

Parameters

empty

The empty value used by the operation.

Definition at line 180 of file quantumhalledge2d.h.

References samples_.

Referenced by QuantumHallEdgePlotWidget::paintEvent(), and MainWindow::updateQuantumHallEdgeAnalysis().

samples()

const std::vector< QuantumHallEdgeSample2D > & qpe::QuantumHallEdgeHistory2D::samples ( ) const

inlinenoexcept

Samples s.

Definition at line 188 of file quantumhalledge2d.h.

References samples_.

Referenced by QuantumHallEdgePlotWidget::paintEvent(), qpe::tests::anonymous_namespace{quantumhalledge2d_tests.cpp}::runOne(), and MainWindow::updateQuantumHallEdgeAnalysis().

trim()

void qpe::QuantumHallEdgeHistory2D::trim ( )

private

Carries out trim.

Definition at line 210 of file quantumhalledge2d.cpp.

References maximumSamples_, and samples_.

Referenced by append().

Member Data Documentation

config_

QuantumHallEdge2DConfig qpe::QuantumHallEdgeHistory2D::config_

private

Definition at line 196 of file quantumhalledge2d.h.

Referenced by append(), clear(), config(), and configure().

configured_

bool qpe::QuantumHallEdgeHistory2D::configured_ = false

private

Definition at line 195 of file quantumhalledge2d.h.

Referenced by append(), clear(), configure(), and configured().

maximumSamples_

std::size_t qpe::QuantumHallEdgeHistory2D::maximumSamples_ = 360u

private

Definition at line 198 of file quantumhalledge2d.h.

Referenced by trim().

samples_

std::vector<QuantumHallEdgeSample2D> qpe::QuantumHallEdgeHistory2D::samples_

private

Definition at line 199 of file quantumhalledge2d.h.

Referenced by append(), clear(), empty(), samples(), and trim().

startMeanX_

double qpe::QuantumHallEdgeHistory2D::startMeanX_ = 0.0

private

Definition at line 197 of file quantumhalledge2d.h.

Referenced by append(), clear(), and configure().

---

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

• core/quantum/quantumhalledge2d.h
• core/quantum/quantumhalledge2d.cpp