srfm::momentum::BetaVelocity Class Reference

Normalised market velocity β = price_velocity / c_market. More...

#include <momentum.hpp>

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

Static Public Member Functions
static std::optional< BetaVelocity >	make (double value) noexcept
	Validate and construct a BetaVelocity.

Detailed Description

Normalised market velocity β = price_velocity / c_market.

Invariant: std::isfinite(value()) && std::abs(value()) < BETA_MAX_SAFE. Construct exclusively via BetaVelocity::make().

Definition at line 72 of file momentum.hpp.

Member Function Documentation

make()

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

staticnoexcept

Validate and construct a BetaVelocity.

Parameters

value

Candidate β value.

Returns

std::nullopt when |value| ≥ BETA_MAX_SAFE or value is non-finite.

Examples

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

Definition at line 18 of file momentum.cpp.

value()

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

inlinenoexcept

Returns the raw β value.

Examples

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

Definition at line 83 of file momentum.hpp.

---

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

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