JTOOLS::JTuple< T > Struct Template Reference

Template data structure. More...

#include <JTuple.hh>

Inheritance diagram for JTOOLS::JTuple< T >:

Public Types
typedef JTypeList< T >	typelist

Public Member Functions
	JTuple ()
	Default constructor. More...
	JTuple (typename JClass< T >::argument_type __first)
	Constructor. More...
JTuple &	negate ()
	Negate tuple. More...
JTuple &	add (const JTuple &tuple)
	Add tuple. More...
JTuple &	sub (const JTuple &tuple)
	Subtract tuple. More...
JTuple &	mul (const double factor)
	Scale tuple. More...
JTuple &	div (const double factor)
	Scale tuple. More...
bool	less (const JTuple &tuple) const
	Compare tuple. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Public Attributes
T	first

Friends
std::istream &	operator>> (std::istream &in, JTuple &tuple)
	Read tuple from input. More...
std::ostream &	operator<< (std::ostream &out, const JTuple &tuple)
	Write tuple to output. More...
JReader &	operator>> (JReader &in, JTuple &tuple)
	Read tuple from input. More...
JWriter &	operator<< (JWriter &out, const JTuple &tuple)
	Write tuple to output. More...

Detailed Description

template<class T>
struct JTOOLS::JTuple< T >

Template data structure.

Definition at line 44 of file JTuple.hh.

Member Typedef Documentation

typelist

template<class T >

typedef JTypeList<T> JTOOLS::JTuple< T >::typelist

Definition at line 49 of file JTuple.hh.

Constructor & Destructor Documentation

JTuple() [1/2]

template<class T >

JTOOLS::JTuple< T >::JTuple ( )

inline

Default constructor.

Definition at line 54 of file JTuple.hh.

    {}

JTuple() [2/2]

template<class T >

JTOOLS::JTuple< T >::JTuple ( typename JClass< T >::argument_type  __first )

inline

Constructor.

Parameters

__first

first

Definition at line 63 of file JTuple.hh.

                                                    :
      first(__first)
    {}

Member Function Documentation

negate()

template<class T >

JTuple& JTOOLS::JTuple< T >::negate ( )

inline

Negate tuple.

Returns

this tuple

Definition at line 73 of file JTuple.hh.

    {
      first = -first;
 
      return *this;
    }

add()

template<class T >

JTuple& JTOOLS::JTuple< T >::add ( const JTuple< T > &  tuple )

inline

Add tuple.

Parameters

tuple

tuple

Returns

this tuple

Definition at line 87 of file JTuple.hh.

    {
      first += tuple.first;
 
      return *this;
    }

sub()

template<class T >

JTuple& JTOOLS::JTuple< T >::sub ( const JTuple< T > &  tuple )

inline

Subtract tuple.

Parameters

tuple

tuple

Returns

this tuple

Definition at line 101 of file JTuple.hh.

    {
      first -= tuple.first;
 
      return *this;
    }

mul() [1/2]

template<class T >

JTuple& JTOOLS::JTuple< T >::mul ( const double  factor )

inline

Scale tuple.

Parameters

factor

multiplication factor

Returns

this tuple

Definition at line 115 of file JTuple.hh.

    {
      first *= factor;
 
      return *this;
    }

div()

template<class T >

JTuple& JTOOLS::JTuple< T >::div ( const double  factor )

inline

Scale tuple.

Parameters

factor

division factor

Returns

this tuple

Definition at line 129 of file JTuple.hh.

    {
      first /= factor;
 
      return *this;
    }

less()

template<class T >

bool JTOOLS::JTuple< T >::less ( const JTuple< T > &  tuple ) const

inline

Compare tuple.

Parameters

tuple

tuple

Returns

true if this tuple less than given tuple; else false

Definition at line 143 of file JTuple.hh.

    {
      return first < tuple.first;
    }

mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t& JMATH::JMath< JFirst_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 Function Documentation

operator>> [1/2]

template<class T >

std::istream& operator>> ( std::istream &  in, JTuple< T > &  tuple  )

friend

Read tuple from input.

Parameters

in	input stream
tuple	tuple

Returns

input stream

Definition at line 156 of file JTuple.hh.

    {
      return in >> tuple.first;
    }

operator<< [1/2]

template<class T >

std::ostream& operator<< ( std::ostream &  out, const JTuple< T > &  tuple  )

friend

Write tuple to output.

Parameters

out	output stream
tuple	tuple

Returns

output stream

Definition at line 169 of file JTuple.hh.

    {
      return out << tuple.first;
    }

operator>> [2/2]

template<class T >

JReader& operator>> ( JReader &  in, JTuple< T > &  tuple  )

friend

Read tuple from input.

Parameters

in	reader
tuple	tuple

Returns

reader

Definition at line 182 of file JTuple.hh.

    {
      return in >> tuple.first;
    }

operator<< [2/2]

template<class T >

JWriter& operator<< ( JWriter &  out, const JTuple< T > &  tuple  )

friend

Write tuple to output.

Parameters

out	writer
tuple	tuple

Returns

writer

Definition at line 195 of file JTuple.hh.

    {
      return out << tuple.first;
    }

Member Data Documentation

first

template<class T >

T JTOOLS::JTuple< T >::first

Definition at line 201 of file JTuple.hh.

---

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

• JTuple.hh