JMATH::JNumber< T > Struct Template Reference

Simple wrapper around template data type to ensure that zero is the default value. More...

#include <JNumber.hh>

Inheritance diagram for JMATH::JNumber< T >:

Public Member Functions
	JNumber ()
	Default constructor.
	JNumber (typename JClass< T >::argument_type value)
	Constructor.
	operator const T & () const
	Type conversion.
	operator T& ()
	Type conversion.
JNumber &	negate ()
	Negate number.
JNumber &	add (const JNumber &number)
	Add number.
JNumber &	sub (const JNumber &number)
	Subtract number.
JNumber &	mul (const double factor)
	Scale number.
JNumber &	div (const double factor)
	Scale number.
bool	less (const JNumber &number) const
	Less than.
JNumber< T > &	mul (const JSecond_t &object)
	Multiply with object.

Public Attributes
T	value

Friends
std::ostream &	operator>> (std::ostream &in, JNumber &number)
	Read number from input stream.
std::ostream &	operator<< (std::ostream &out, const JNumber &number)
	Write number to output stream.

Detailed Description

template<class T>
struct JMATH::JNumber< T >

Simple wrapper around template data type to ensure that zero is the default value.

Definition at line 32 of file JMath/JNumber.hh.

Constructor & Destructor Documentation

JNumber() [1/2]

template<class T >

JMATH::JNumber< T >::JNumber ( )

inline

Default constructor.

Definition at line 39 of file JMath/JNumber.hh.

              :
      value(getZero<T>())
    {}

JNumber() [2/2]

template<class T >

JMATH::JNumber< T >::JNumber ( typename JClass< T >::argument_type value )

inline

Constructor.

Parameters

value

value

Definition at line 49 of file JMath/JNumber.hh.

                                                   :
      value(value)
    {}

Member Function Documentation

operator const T &()

template<class T >

JMATH::JNumber< T >::operator const T & ( ) const

inline

Type conversion.

Returns

value

Definition at line 59 of file JMath/JNumber.hh.

    { 
      return value;
    }

operator T&()

template<class T >

JMATH::JNumber< T >::operator T& ( )

inline

Type conversion.

Returns

value

Definition at line 70 of file JMath/JNumber.hh.

    { 
      return value;
    }

negate()

template<class T >

JNumber & JMATH::JNumber< T >::negate ( )

inline

Negate number.

Returns

this number

Definition at line 81 of file JMath/JNumber.hh.

    {
      value = -value;
 
      return *this;
    }

add()

template<class T >

JNumber & JMATH::JNumber< T >::add ( const JNumber< T > & number )

inline

Add number.

Parameters

number

number

Returns

this number

Definition at line 95 of file JMath/JNumber.hh.

    {
      value += number.value;
 
      return *this;
    }

sub()

template<class T >

JNumber & JMATH::JNumber< T >::sub ( const JNumber< T > & number )

inline

Subtract number.

Parameters

number

number

Returns

this number

Definition at line 109 of file JMath/JNumber.hh.

    {
      value -= number.value;
 
      return *this;
    }

mul() [1/2]

template<class T >

JNumber & JMATH::JNumber< T >::mul ( const double factor )

inline

Scale number.

Parameters

factor

multiplication factor

Returns

this number

Definition at line 123 of file JMath/JNumber.hh.

    {
      value *= factor;
 
      return *this;
    }

div()

template<class T >

JNumber & JMATH::JNumber< T >::div ( const double factor )

inline

Scale number.

Parameters

factor

division factor

Returns

this number

Definition at line 137 of file JMath/JNumber.hh.

    {
      value /= factor;
 
      return *this;
    }

less()

template<class T >

bool JMATH::JNumber< T >::less ( const JNumber< T > & number ) const

inline

Less than.

Parameters

number

number

Returns

true if number is less than given number; else false

Definition at line 151 of file JMath/JNumber.hh.

    {
      return value < number.value;
    }

mul() [2/2]

JNumber< T > & JMATH::JMath< JNumber< T >, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Symbol Documentation

operator>>

template<class T >

std::ostream & operator>> ( std::ostream & in, JNumber< T > & number )

friend

Read number from input stream.

Parameters

in	input stream
number	number

Returns

input stream

Definition at line 164 of file JMath/JNumber.hh.

    {
      return in >> number.value;
    }

operator<<

template<class T >

std::ostream & operator<< ( std::ostream & out, const JNumber< T > & number )

friend

Write number to output stream.

Parameters

out	output stream
number	number

Returns

output stream

Definition at line 177 of file JMath/JNumber.hh.

    {
      return out << number.value;
    }

Member Data Documentation

value

template<class T >

T JMATH::JNumber< T >::value

Definition at line 183 of file JMath/JNumber.hh.

---

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

• JMath/JNumber.hh