One dimensional array of template objects with fixed length. More...

#include <JArray.hh>

Inheritance diagram for JTOOLS::JArray< 1, T >:

Public Types
typedef const T *	const_pointer

typedef T *	pointer

typedef const T *	const_iterator

typedef T *	iterator

typedef std::reverse_iterator < const_iterator >	const_reverse_iterator

typedef std::reverse_iterator < iterator >	reverse_iterator

typedef T &	reference

typedef const T &	const_reference

typedef unsigned int	size_type

typedef JLANG::JClass< T > ::argument_type	argument_type

Public Member Functions
	JArray ()
	Default constructor. More...

template<unsigned int M>
	JArray (const JArray< M, T > &array)
	Copy constructor. More...

template<unsigned int M>
	JArray (const JArray< M, const T > &array)
	Copy constructor. More...

	JArray (argument_type x)
	Initialise constructor. More...

	JArray (const T *p)
	Constructor. More...

	JArray (const JMultiKey< 1, T > &key)
	Constructor. More...

	JArray (const JMultiKey< 1, const T > &key)
	Constructor. More...

const_iterator	begin () const
	get iterator to begin of data More...

const_iterator	end () const
	get iterator to end of data More...

iterator	begin ()
	get iterator to begin of data More...

iterator	end ()
	get iterator to end of data More...

const_reverse_iterator	rbegin () const
	get reverse iterator to begin of data More...

const_reverse_iterator	rend () const
	get reverse iterator to begin of data More...

reverse_iterator	rbegin ()
	get reverse iterator to begin of data More...

reverse_iterator	rend ()
	get reverse iterator to end of data More...

const_reference	operator[] (int index) const
	Get element at given index. More...

reference	operator[] (int index)
	Get element at given index. More...

const_reference	at (int index) const
	Get element at given index. More...

reference	at (int index)
	Get element at given index. More...

const_pointer	data () const
	Get pointer to data. More...

pointer	data ()
	Get pointer to data. More...

JArray &	negate ()
	Negate array. More...

JArray &	add (const JArray &array)
	Add array. More...

JArray &	sub (const JArray &array)
	Subtract array. More...

JArray &	mul (const double factor)
	Scale array. More...

JArray &	div (const double factor)
	Scale array. More...

bool	equals (const JArray< N, T > &array) const
	Check equality. More...

JArray< 1, T > &	mul (const JNullType &object)
	Multiply with object. More...

Static Public Member Functions
static size_type	size ()
	Get size of data. More...

Static Public Attributes
static const unsigned int	N = 1

Protected Attributes
T	buffer [1]

Friends
JReader &	operator>> (JReader &in, JArray &buffer)
	Read array from input. More...

JWriter &	operator<< (JWriter &out, const JArray &buffer)
	Write array to output. More...

Detailed Description

template<class T>
class JTOOLS::JArray< 1, T >

One dimensional array of template objects with fixed length.

The internal data structure consists of a standard C-array.

Definition at line 491 of file JArray.hh.

Member Typedef Documentation

template<class T >

typedef const T* JTOOLS::JArray< 1, T >::const_pointer

Definition at line 499 of file JArray.hh.

template<class T >

typedef T* JTOOLS::JArray< 1, T >::pointer

Definition at line 500 of file JArray.hh.

template<class T >

typedef const T* JTOOLS::JArray< 1, T >::const_iterator

Definition at line 501 of file JArray.hh.

template<class T >

typedef T* JTOOLS::JArray< 1, T >::iterator

Definition at line 502 of file JArray.hh.

template<class T >

typedef std::reverse_iterator<const_iterator> JTOOLS::JArray< 1, T >::const_reverse_iterator

Definition at line 503 of file JArray.hh.

template<class T >

typedef std::reverse_iterator<iterator> JTOOLS::JArray< 1, T >::reverse_iterator

Definition at line 504 of file JArray.hh.

template<class T >

typedef T& JTOOLS::JArray< 1, T >::reference

Definition at line 505 of file JArray.hh.

template<class T >

typedef const T& JTOOLS::JArray< 1, T >::const_reference

Definition at line 506 of file JArray.hh.

template<class T >

typedef unsigned int JTOOLS::JArray< 1, T >::size_type

Definition at line 507 of file JArray.hh.

template<class T >

typedef JLANG::JClass<T>::argument_type JTOOLS::JArray< 1, T >::argument_type

Definition at line 508 of file JArray.hh.

Constructor & Destructor Documentation

template<class T >

JTOOLS::JArray< 1, T >::JArray ( )

inline

Default constructor.

Definition at line 514 of file JArray.hh.

515 {}

template<class T >

template<unsigned int M>

JTOOLS::JArray< 1, T >::JArray ( const JArray< M, T > & array )

inline

Copy constructor.

Parameters

array array

Definition at line 524 of file JArray.hh.

     {
       buffer[0] = array[0];
     }

template<class T >

template<unsigned int M>

JTOOLS::JArray< 1, T >::JArray ( const JArray< M, const T > & array )

inline

Copy constructor.

Parameters

array array

Definition at line 536 of file JArray.hh.

     {
       buffer[0] = array[0];
     }

template<class T >

JTOOLS::JArray< 1, T >::JArray ( argument_type x )

inline

Initialise constructor.

Parameters

x value;

Definition at line 547 of file JArray.hh.

     {
       buffer[0] = x;
     }

template<class T >

JTOOLS::JArray< 1, T >::JArray ( const T * p )

inline

Constructor.

Parameters

p	pointer to data

Definition at line 558 of file JArray.hh.

     {
       buffer[0] = p[0];
     }

template<class T >

JTOOLS::JArray< 1, T >::JArray ( const JMultiKey< 1, T > & key )

inline

Constructor.

Parameters

key	multi-dimensional key

Definition at line 569 of file JArray.hh.

     {
       buffer[0] = key.first;
     }

template<class T >

JTOOLS::JArray< 1, T >::JArray ( const JMultiKey< 1, const T > & key )

inline

Constructor.

Parameters

key	multi-dimensional key

Definition at line 580 of file JArray.hh.

     {
       buffer[0] = key.first;
     }

Member Function Documentation

template<class T >

const_iterator JTOOLS::JArray< 1, T >::begin ( ) const

inline

get iterator to begin of data

Definition at line 586 of file JArray.hh.

template<class T >

const_iterator JTOOLS::JArray< 1, T >::end ( ) const

inline

get iterator to end of data

Definition at line 587 of file JArray.hh.

template<class T >

iterator JTOOLS::JArray< 1, T >::begin ( )

inline

get iterator to begin of data

Definition at line 590 of file JArray.hh.

template<class T >

iterator JTOOLS::JArray< 1, T >::end ( )

inline

get iterator to end of data

Definition at line 591 of file JArray.hh.

template<class T >

const_reverse_iterator JTOOLS::JArray< 1, T >::rbegin ( ) const

inline

get reverse iterator to begin of data

Definition at line 594 of file JArray.hh.

template<class T >

const_reverse_iterator JTOOLS::JArray< 1, T >::rend ( ) const

inline

get reverse iterator to begin of data

Definition at line 595 of file JArray.hh.

template<class T >

reverse_iterator JTOOLS::JArray< 1, T >::rbegin ( )

inline

get reverse iterator to begin of data

Definition at line 598 of file JArray.hh.

template<class T >

reverse_iterator JTOOLS::JArray< 1, T >::rend ( )

inline

get reverse iterator to end of data

Definition at line 599 of file JArray.hh.

template<class T >

const_reference JTOOLS::JArray< 1, T >::operator[] ( int index ) const

inline

Get element at given index.

Parameters

index index

Returns: element

Definition at line 608 of file JArray.hh.

     { 
       return buffer[index];
     }

template<class T >

reference JTOOLS::JArray< 1, T >::operator[] ( int index )

inline

Get element at given index.

Parameters

index index

Returns: element

Definition at line 620 of file JArray.hh.

     {
       return buffer[index];
     }

template<class T >

const_reference JTOOLS::JArray< 1, T >::at ( int index ) const

inline

Get element at given index.

Parameters

index index

Returns: element at index

Definition at line 632 of file JArray.hh.

     { 
       if (index >= 0 && index < N)
         return buffer[index];
       else
         throw JIndexOutOfRange("JArray<>::at()");
     }

template<class T >

reference JTOOLS::JArray< 1, T >::at ( int index )

inline

Get element at given index.

Parameters

index index

Returns: element at index

Definition at line 647 of file JArray.hh.

     { 
       if (index >= 0 && index < N)
         return buffer[index];
       else
         throw JIndexOutOfRange("JArray<>::at()");
     }

template<class T >

const_pointer JTOOLS::JArray< 1, T >::data ( ) const

inline

Get pointer to data.

Returns: pointer to data

Definition at line 661 of file JArray.hh.

     { 
       return buffer;
     }

template<class T >

pointer JTOOLS::JArray< 1, T >::data ( )

inline

Get pointer to data.

Returns: pointer to data

Definition at line 672 of file JArray.hh.

     { 
       return buffer;
     }

template<class T >

static size_type JTOOLS::JArray< 1, T >::size ( )

inlinestatic

Get size of data.

Returns: size of data

Definition at line 683 of file JArray.hh.

     { 
       return N;
     }

template<class T >

JArray& JTOOLS::JArray< 1, T >::negate ( )

inline

Negate array.

Returns: this array

Definition at line 694 of file JArray.hh.

     {
       buffer[0] = -buffer[0];
 
       return *this;
     }

template<class T >

JArray& JTOOLS::JArray< 1, T >::add ( const JArray< 1, T > & array )

inline

Add array.

Parameters

array array

Returns: this array

Definition at line 708 of file JArray.hh.

     {
       buffer[0] += array[0];
 
       return *this;
     }

template<class T >

JArray& JTOOLS::JArray< 1, T >::sub ( const JArray< 1, T > & array )

inline

Subtract array.

Parameters

array array

Returns: this array

Definition at line 722 of file JArray.hh.

     {
       buffer[0] -= array[0];
 
       return *this;
     }

template<class T >

JArray& JTOOLS::JArray< 1, T >::mul ( const double factor )

inline

Scale array.

Parameters

factor multiplication factor

Returns: this array

Definition at line 736 of file JArray.hh.

     {
       buffer[0] *= factor;
 
       return *this;
     }

template<class T >

JArray& JTOOLS::JArray< 1, T >::div ( const double factor )

inline

Scale array.

Parameters

factor division factor

Returns: this array

Definition at line 750 of file JArray.hh.

     {
       buffer[0] /= factor;
 
       return *this;
     }

template<class T >

bool JTOOLS::JArray< 1, T >::equals ( const JArray< N, T > & array ) const

inline

Check equality.

Parameters

array array

Returns: true if arrays are equal; else false

Definition at line 764 of file JArray.hh.

     {
       return buffer[0] == array[0];
     }

JArray< 1, T > & JMATH::JMath< JArray< 1, T > , JNullType >::mul ( const JNullType & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

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

Friends And Related Function Documentation

template<class T >

JReader& operator>>	(	JReader &	in,
		JArray< 1, T > &	buffer
	)

friend

Read array from input.

Parameters

in	reader
buffer	array

Returns: reader

Definition at line 777 of file JArray.hh.

     {
       return in >> buffer[0];
     }

template<class T >

JWriter& operator<<	(	JWriter &	out,
		const JArray< 1, T > &	buffer
	)

friend

Write array to output.

Parameters

out	writer
buffer	array

Returns: writer

Definition at line 790 of file JArray.hh.

     {
       return out << buffer[0];
     }

Member Data Documentation

template<class T >

const unsigned int JTOOLS::JArray< 1, T >::N = 1

static

Definition at line 497 of file JArray.hh.

template<class T >

T JTOOLS::JArray< 1, T >::buffer[1]

protected

Definition at line 796 of file JArray.hh.

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

JArray.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<class T> class JTOOLS::JArray< 1, T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class T>
class JTOOLS::JArray< 1, T >