Model of a physically dimensioned quantity. More...

#include <dimval.hpp>

Inheritance diagram for vnix::units::dimval< T, B >:

Collaboration diagram for vnix::units::dimval< T, B >:

Public Member Functions
	dimval ()
	< Allow access to dimension. More...

constexpr	dimval (T const &v, dim const &d)
	Initialize from numeric value and from dimension. More...

template<typename OT , typename OB >
constexpr	dimval (dimval< OT, OB > const &v)
	Initialize from other dimensioned value. More...

constexpr	dimval (T const &n)
	Initialize from dimensionless number. More...

constexpr T	to_number () const
	Convert to dimensionless number. More...

constexpr dim::rat	d (dim::off off) const
	Exponent for base at specified offset. More...

template<typename OT , typename OB >
constexpr auto	operator== (dimval< OT, OB > const &v) const
	Equality-comparison of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator!= (dimval< OT, OB > const &v) const
	Inequality-comparison of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator< (dimval< OT, OB > const &v) const
	Less-than comparison of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator<= (dimval< OT, OB > const &v) const
	Less-than-or-equal comparison of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator> (dimval< OT, OB > const &v) const
	Greater-than comparison of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator>= (dimval< OT, OB > const &v) const
	Greater-than-or-equal comparison of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator+ (dimval< OT, OB > const &v) const
	Sum of two dimensioned values. More...

template<typename OT , typename OB >
constexpr auto	operator- (dimval< OT, OB > const &v) const
	Difference between two dimensioned values. More...

template<typename OT , typename OB >
constexpr dimval &	operator+= (dimval< OT, OB > const &v)
	Modify present instance by adding in a dimensioned value. More...

template<typename OT , typename OB >
constexpr dimval &	operator-= (dimval< OT, OB > const &v)
	Modify present instance by subtracting out a dimensioned value. More...

template<typename OT , otest< OT > = 0>
constexpr auto	operator* (OT const &n) const
	Scale dimensioned value. More...

template<typename OT , typename OB >
constexpr auto	operator* (dimval< OT, OB > const &v) const
	Multiply two dimensioned values. More...

constexpr auto	operator[] (size_t off) const
	Support element-access in case it be supported by numeric type. More...

template<typename OT , otest< OT > = 0>
constexpr auto	dot (OT const &n) const
	Support dot-product in case it be supported by numeric type. More...

template<typename OT , typename OB >
constexpr auto	dot (dimval< OT, OB > const &v) const
	Support dot-product in case it be supported by numeric type. More...

template<typename OT , otest< OT > = 0>
constexpr auto	cross (OT const &n) const
	Support cross-product in case it be supported by numeric type. More...

template<typename OT , typename OB >
constexpr auto	cross (dimval< OT, OB > const &v) const
	Support cross-product in case it be supported by numeric type. More...

template<typename OT , otest< OT > = 0>
constexpr auto	operator/ (OT const &n) const
	Scale dimensioned quantity by dividing by number. More...

constexpr dimval< T, typename B::recip_basedim >	inverse () const
	Invert dimensioned value. More...

template<typename OT , typename OB >
constexpr auto	operator/ (dimval< OT, OB > const &v) const
	Divide two dimensioned values. More...

template<typename OT , otest< OT > = 0>
constexpr dimval &	operator*= (OT const &v)
	Modify present instance by multiplying in a dimensionless value. More...

template<typename OT , otest< OT > = 0>
constexpr dimval &	operator/= (OT const &v)
	Modify present instance by dividing it by a dimensionless value. More...

template<int64_t PN, int64_t PD = 1>
constexpr auto	power () const
	Raise dimensioned value to rational power. More...

constexpr auto	power (dim::rat p) const
	Raise dimensioned value to rational power. More...

constexpr auto	square_root () const
	Square-root of a dimensioned quantity. More...

Protected Member Functions
	dimval (dim const &d)
	Initialize dimension, but leave number undefined. More...

Friends
template<typename OT , typename OB >
class	dimval
	Allow access to every kind of dimval. More...

template<typename OT >
class	basic_dyndim
	Allow access to each kind (float or double) of dyndim. More...

template<dim::word D, typename OT >
class	basic_statdim
	Allow access to every kind of statdim. More...

template<typename OT , otest< OT > = 0>
constexpr auto	operator* (OT const &n, dimval const &v)
	Scale dimensioned value. More...

std::ostream &	operator<< (std::ostream &s, dimval const &v)
	Print to to output stream. More...

Detailed Description

template<typename T, typename B>
class vnix::units::dimval< T, B >

Model of a physically dimensioned quantity.

Template Parameters

T	Type of storage (e.g., float or double) for numerical quantity.
B	Base-class (statdim_base or dyndim_base) for dimension.

Definition at line 22 of file dimval.hpp.

Constructor & Destructor Documentation

template<typename T, typename B>

vnix::units::dimval< T, B >::dimval ( dim const & d )

inlineprotected

Initialize dimension, but leave number undefined.

Parameters

d	Dimension.

Definition at line 72 of file dimval.hpp.

72 : B(d) {}

vnix::units::dimval::d

constexpr dim::rat d(dim::off off) const

Exponent for base at specified offset.

Definition: dimval.hpp:109

template<typename T, typename B>

vnix::units::dimval< T, B >::dimval ( )

inline

< Allow access to dimension.

By default, do not initialize.

Definition at line 78 of file dimval.hpp.

template<typename T, typename B>

constexpr vnix::units::dimval< T, B >::dimval	(	T const &	v,
		dim const &	d
	)

inline

Initialize from numeric value and from dimension.

NOTE: This is public not because it ought to be called by the user but because there is no easy way to allow every friend operator access to every kind of dimval.

Parameters

v	Numeric value.
d	Dimension.

Definition at line 88 of file dimval.hpp.

88 : number<T>(v), B(d) {}

vnix::units::dimval::d

constexpr dim::rat d(dim::off off) const

Exponent for base at specified offset.

Definition: dimval.hpp:109

template<typename T, typename B>

template<typename OT , typename OB >

constexpr vnix::units::dimval< T, B >::dimval ( dimval< OT, OB > const & v )

inline

Initialize from other dimensioned value.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Definition at line 95 of file dimval.hpp.

95 : number<T>(v.v_), B(v.d()) {}

template<typename T, typename B>

constexpr vnix::units::dimval< T, B >::dimval ( T const & n )

inline

Initialize from dimensionless number.

Parameters

n Number.

Definition at line 99 of file dimval.hpp.

99 : number<T>(n), B(dim()) {}

vnix::units::dim

basic_dim< dim_base_off > dim

Define dim as specification of basic_dim by way of YAML- and ERB-generated type dim_base_off.

Definition: dim.hpp:260

Member Function Documentation

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr auto vnix::units::dimval< T, B >::cross ( OT const & n ) const

inline

Support cross-product in case it be supported by numeric type.

Template Parameters

OT	Numeric type of factor.

Parameters

n Factor.

Returns: Cross-product.

Definition at line 302 of file dimval.hpp.

                                           {
     auto prod = v_.cross(n);
     return dimval<decltype(prod), B>(prod, d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::cross ( dimval< OT, OB > const & v ) const

inline

Support cross-product in case it be supported by numeric type.

Template Parameters

OT	Numeric type of factor.
OB	Base-dimension type of factor.

Parameters

v Factor.

Returns: Dot-product.

Definition at line 313 of file dimval.hpp.

                                                       {
     auto const pdim = B::prod(v);
     auto       prod = v_.cross(v.v_);
     return dimval<decltype(prod), decltype(pdim)>(prod, pdim.d());
   }

template<typename T, typename B>

constexpr dim::rat vnix::units::dimval< T, B >::d ( dim::off off ) const

inline

Exponent for base at specified offset.

Parameters

off Offset.

Definition at line 109 of file dimval.hpp.

109 { return B::d()[off]; }

Here is the caller graph for this function:

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr auto vnix::units::dimval< T, B >::dot ( OT const & n ) const

inline

Support dot-product in case it be supported by numeric type.

Template Parameters

OT	Numeric type of factor.

Parameters

n Factor.

Returns: Dot-product.

Definition at line 280 of file dimval.hpp.

                                                                               {
     auto prod = v_.dot(n);
     return dimval<decltype(prod), B>(prod, d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::dot ( dimval< OT, OB > const & v ) const

inline

Support dot-product in case it be supported by numeric type.

Template Parameters

OT	Numeric type of factor.
OB	Base-dimension type of factor.

Parameters

v Factor.

Returns: Dot-product.

Definition at line 291 of file dimval.hpp.

                                                     {
     auto const pdim = B::prod(v);
     auto       prod = v_.dot(v.v_);
     return dimval<decltype(prod), decltype(pdim)>(prod, pdim.d());
   }

template<typename T, typename B>

constexpr dimval<T, typename B::recip_basedim> vnix::units::dimval< T, B >::inverse ( ) const

inline

Invert dimensioned value.

Returns: Reciprocal of dimval.

Definition at line 335 of file dimval.hpp.

                                                                {
     auto const br = this->recip();
     return dimval<T, typename B::recip_basedim>(invert(v_), br.d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator!= ( dimval< OT, OB > const & v ) const

inline

Inequality-comparison of two dimensioned values.

This will throw an exception if the dimensions are different.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Returns: True only if this and the other be unequal.

Definition at line 130 of file dimval.hpp.

                                                            {
     return !(*this == v);
   }

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr auto vnix::units::dimval< T, B >::operator* ( OT const & n ) const

inline

Scale dimensioned value.

This function's scope for matching the template-type parameter is limited by SFINAE.

Template Parameters

OT	Type of scale-factor.

Parameters

n	Scale-factor.

Returns: Scaled value.

Definition at line 237 of file dimval.hpp.

                                               {
     auto prod = v_ * n;
     return dimval<decltype(prod), B>(prod, d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator* ( dimval< OT, OB > const & v ) const

inline

Multiply two dimensioned values.

Template Parameters

OT	Numeric type of factor.
OB	Base-dimension type of factor.

Parameters

v Factor.

Returns: Product.

Definition at line 263 of file dimval.hpp.

                                                           {
     auto const pdim = B::prod(v);
     auto       prod = v_ * v.v_;
     return dimval<decltype(prod), decltype(pdim)>(prod, pdim.d());
   }

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr dimval& vnix::units::dimval< T, B >::operator*= ( OT const & v )

inline

Modify present instance by multiplying in a dimensionless value.

This function's scope for matching the template-type parameter is limited by SFINAE.

Template Parameters

OT	Type of scale-factor.

Parameters

v	Dimensionless scale-factor.

Returns: Scaled value.

Definition at line 361 of file dimval.hpp.

                                             {
     v_ *= v;
     return *this;
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator+ ( dimval< OT, OB > const & v ) const

inline

Sum of two dimensioned values.

Template Parameters

OT	Numeric type of addend.
OB	Base-dimension type of addend.

Parameters

v Addend.

Returns: Sum.

Definition at line 186 of file dimval.hpp.

                                                           {
     auto const sdim = B::sum(v); // Check for compatibility of units.
     auto       sum  = v_ + v.v_;
     return dimval<decltype(sum), B>(sum, sdim.d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr dimval& vnix::units::dimval< T, B >::operator+= ( dimval< OT, OB > const & v )

inline

Modify present instance by adding in a dimensioned value.

Template Parameters

OT	Numeric type of addend.
OB	Base-dimension type of addend.

Parameters

v Addend.

Returns: Sum.

Definition at line 210 of file dimval.hpp.

                                                         {
     B::sum(v); // Check for compatibility of units.
     v_ += v.v_;
     return *this;
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator- ( dimval< OT, OB > const & v ) const

inline

Difference between two dimensioned values.

Template Parameters

OT	Numeric type of subtractor.
OB	Base-dimension type of subtractor.

Parameters

v	Subractor.

Returns: Difference.

Definition at line 198 of file dimval.hpp.

                                                           {
     auto const ddim = B::diff(v); // Check for compatibility of units.
     auto       diff = v_ - v.v_;
     return dimval<decltype(diff), B>(diff, ddim.d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr dimval& vnix::units::dimval< T, B >::operator-= ( dimval< OT, OB > const & v )

inline

Modify present instance by subtracting out a dimensioned value.

Template Parameters

OT	Numeric type of subtractor.
OB	Base-dimension type of subtractor.

Parameters

v	Subtractor.

Returns: Difference.

Definition at line 222 of file dimval.hpp.

                                                         {
     B::diff(v); // Check for compatibility of units.
     v_ -= v.v_;
     return *this;
   }

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr auto vnix::units::dimval< T, B >::operator/ ( OT const & n ) const

inline

Scale dimensioned quantity by dividing by number.

This function's scope for matching the template-type parameter is limited by SFINAE.

Template Parameters

OT	Type of scale-factor.

Parameters

n	Scale-divisor.

Returns: Scaled value.

Definition at line 328 of file dimval.hpp.

                                               {
     auto quot = v_ / n;
     return dimval<decltype(quot), B>(quot, d());
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator/ ( dimval< OT, OB > const & v ) const

inline

Divide two dimensioned values.

Template Parameters

OT	Numeric type of divisor.
OB	Base-dimension type of divisor.

Parameters

v Divisor.

Returns: Quotient.

Definition at line 346 of file dimval.hpp.

                                                           {
     auto const qdim = B::quot(v);
     auto       quot = v_ / v.v_;
     return dimval<decltype(quot), decltype(qdim)>(v_ / v.v_, qdim.d());
   }

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr dimval& vnix::units::dimval< T, B >::operator/= ( OT const & v )

inline

Modify present instance by dividing it by a dimensionless value.

This function's scope for matching the template-type parameter is limited by SFINAE.

Template Parameters

OT	Type of scale-factor.

Parameters

v	Dimensionless scale-divisor.

Returns: Scaled value.

Definition at line 375 of file dimval.hpp.

                                             {
     v_ /= v;
     return *this;
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator< ( dimval< OT, OB > const & v ) const

inline

Less-than comparison of two dimensioned values.

This will throw an exception if the dimensions are different.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Returns: True only if this be less than the other.

Definition at line 141 of file dimval.hpp.

                                                           {
     B::comparison(v); // Check for compatibility of units.
     return v_ < v.v_;
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator<= ( dimval< OT, OB > const & v ) const

inline

Less-than-or-equal comparison of two dimensioned values.

This will throw an exception if the dimensions are different.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Returns: True only if this be less than or equal to the other.

Definition at line 153 of file dimval.hpp.

                                                            {
     B::comparison(v); // Check for compatibility of units.
     return v_ <= v.v_;
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator== ( dimval< OT, OB > const & v ) const

inline

Equality-comparison of two dimensioned values.

This will throw an exception if the dimensions are different.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Returns: True only if this and the other be equal.

Definition at line 118 of file dimval.hpp.

                                                            {
     B::comparison(v); // Check for compatibility of units.
     return v_ == v.v_;
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator> ( dimval< OT, OB > const & v ) const

inline

Greater-than comparison of two dimensioned values.

This will throw an exception if the dimensions are different.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Returns: True only if this be greater than the other.

Definition at line 165 of file dimval.hpp.

                                                           {
     return !(*this <= v);
   }

template<typename T, typename B>

template<typename OT , typename OB >

constexpr auto vnix::units::dimval< T, B >::operator>= ( dimval< OT, OB > const & v ) const

inline

Greater-than-or-equal comparison of two dimensioned values.

This will throw an exception if the dimensions are different.

Template Parameters

OT	Numeric type of other dimensioned value.
OB	Base-dimension type of other dimensioned value.

Parameters

v	Reference to other dimensioned value.

Returns: True only if this be greater than or equal to the other.

Definition at line 176 of file dimval.hpp.

                                                            {
     return !(*this < v);
   }

template<typename T, typename B>

constexpr auto vnix::units::dimval< T, B >::operator[] ( size_t off ) const

inline

Support element-access in case it be supported by numeric type.

Parameters

off	Offset of element.

Definition at line 271 of file dimval.hpp.

                                               {
     auto e = v_[off];
     return dimval<decltype(e), B>(e, d());
   }

template<typename T, typename B>

template<int64_t PN, int64_t PD = 1>

constexpr auto vnix::units::dimval< T, B >::power ( ) const

inline

Raise dimensioned value to rational power.

Template Parameters

PN	Numerator of power.
PD	Denominator of power (by default, 1).

Returns: Transformed value of different dimension.

Definition at line 384 of file dimval.hpp.

                                                                      {
     auto const pdim = B::template pow<PN, PD>();
     auto const powr = pow(v_, PN * 1.0 / PD);
     return dimval<T, decltype(pdim)>(powr, pdim.d());
   }

template<typename T, typename B>

constexpr auto vnix::units::dimval< T, B >::power ( dim::rat p ) const

inline

Raise dimensioned value to rational power.

Parameters

p	Rational power.

Returns: Transformed value of different dimension.

Definition at line 393 of file dimval.hpp.

                                        {
     auto const pdim = B::pow(p);
     auto const powr = pow(v_, p.to_double());
     return dimval<T, decltype(pdim)>(powr, pdim.d());
   }

template<typename T, typename B>

constexpr auto vnix::units::dimval< T, B >::square_root ( ) const

inline

Square-root of a dimensioned quantity.

Definition at line 400 of file dimval.hpp.

                                      {
     auto const rdim = B::sqrt();
     T const    root = sqrt(v_);
     return dimval<T, decltype(rdim)>(root, rdim.d());
   }

template<typename T, typename B>

constexpr T vnix::units::dimval< T, B >::to_number ( ) const

inline

Convert to dimensionless number.

Definition at line 102 of file dimval.hpp.

                                 {
     B::number();
     return v_;
   }

Here is the caller graph for this function:

Friends And Related Function Documentation

template<typename T, typename B>

template<typename OT >

friend class basic_dyndim

friend

Allow access to each kind (float or double) of dyndim.

Template Parameters

OT	Type of dyndim's numeric value.

Definition at line 62 of file dimval.hpp.

template<typename T, typename B>

template<dim::word D, typename OT >

friend class basic_statdim

friend

Allow access to every kind of statdim.

Template Parameters

D	Encoding of dimension in dim::word.
OT	Type of statdim's numeric value.

Definition at line 67 of file dimval.hpp.

template<typename T, typename B>

template<typename OT , typename OB >

friend class dimval

friend

Allow access to every kind of dimval.

Template Parameters

OT	Type of other dimval's numeric value.
OB	Type of other dimval's base-class for dimension.

Definition at line 58 of file dimval.hpp.

template<typename T, typename B>

template<typename OT , otest< OT > = 0>

constexpr auto operator*	(	OT const &	n,
		dimval< T, B > const &	v
	)

friend

Scale dimensioned value.

This function's scope for matching the template-type parameter is limited by SFINAE.

Template Parameters

OT	Type of scale-factor.

Parameters

n	Scale-factor.
v	Original value.

Returns: Scaled value.

Definition at line 252 of file dimval.hpp.

                                                                 {
     auto prod = n * v.v_;
     return dimval<decltype(prod), B>(prod, v.d());
   }

template<typename T, typename B>

std::ostream& operator<<	(	std::ostream &	s,
		dimval< T, B > const &	v
	)

friend

Print to to output stream.

Definition at line 407 of file dimval.hpp.

                                                                 {
     return s << v.v_ << v.d();
   }

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

vnix/units/dimval.hpp

Public Member Functions

Protected Member Functions

Friends

Detailed Description

template<typename T, typename B> class vnix::units::dimval< T, B >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename T, typename B>
class vnix::units::dimval< T, B >