srfm::momentum::EffectiveMass Class Reference

ADV-based effective mass proxy. More...

#include <momentum.hpp>

Public Member Functions
double	value () const noexcept
	Returns the raw m_eff value.

Static Public Member Functions
static std::optional< EffectiveMass >	make (double value) noexcept
	Validate and construct an EffectiveMass.
static std::optional< EffectiveMass >	from_adv (double adv, double adv_baseline) noexcept
	Construct from raw ADV and a baseline ADV.

Detailed Description

ADV-based effective mass proxy.

m_eff = adv / adv_baseline. Invariant: value() > 0 and std::isfinite(value()). Construct via EffectiveMass::make() or EffectiveMass::from_adv().

Definition at line 128 of file momentum.hpp.

Member Function Documentation

from_adv()

std::optional< EffectiveMass > srfm::momentum::EffectiveMass::from_adv ( double  adv, double  adv_baseline  )

staticnoexcept

Construct from raw ADV and a baseline ADV.

m_eff = adv / adv_baseline.

Returns

std::nullopt when either argument is non-positive or non-finite.

Examples

/home/runner/work/Special-Relativity-in-Financial-Modeling/Special-Relativity-in-Financial-Modeling/src/momentum/momentum.hpp.

Definition at line 33 of file momentum.cpp.

make()

std::optional< EffectiveMass > srfm::momentum::EffectiveMass::make ( double  value )

staticnoexcept

Validate and construct an EffectiveMass.

Returns

std::nullopt when value ≤ 0 or non-finite.

Examples

/home/runner/work/Special-Relativity-in-Financial-Modeling/Special-Relativity-in-Financial-Modeling/src/momentum/momentum.hpp.

Definition at line 27 of file momentum.cpp.

value()

double srfm::momentum::EffectiveMass::value ( ) const

inlinenoexcept

Returns the raw m_eff value.

Examples

/home/runner/work/Special-Relativity-in-Financial-Modeling/Special-Relativity-in-Financial-Modeling/src/momentum/momentum.hpp.

Definition at line 147 of file momentum.hpp.

---

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

• src/momentum/momentum.hpp
• src/momentum/momentum.cpp