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

#include <JArray.hh>

Inheritance diagram for JTOOLS::JArray< N, 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 (const T *p)
	Copy constructor. More...

	JArray (const JMultiKey< N, T > &key)
	Copy constructor. More...

	JArray (const JMultiKey< N, const T > &key)
	Copy constructor. More...

	JArray (const JArray< N-1, T > &array, argument_type value)
	Append constructor. More...

	JArray (const JArray< N-1, const T > &array, argument_type value)
	Append constructor. More...

	JArray (const JMultiKey< N-1, T > &key, argument_type value)
	Append constructor. More...

	JArray (const JMultiKey< N-1, const T > &key, argument_type value)
	Append constructor. More...

template<class... Args>
	JArray (const Args &...args)
	Initialise constructor. More...

template<class... Args>
JArray &	set (const Args &...args)
	Set array. 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< N-1, T >	pop_front () const
	Make a copy in which the first element is removed. More...

JArray< N-1, T >	pop_back () const
	Make a copy in which the last element is removed. 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< N, T > &	mul (const JNullType &object)
	Multiply with object. More...

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

Protected Member Functions
template<class... Args>
void	__set__ (const int i, const argument_type x, const Args &...args)
	Recursive method for setting array. More...

void	__set__ (const int i) const
	Termination method for setting array. More...

template<unsigned int M>
void	assign (const JMultiKey< M, T > &key)
	Recursive method for setting array. More...

template<unsigned int M>
void	assign (const JMultiKey< M, const T > &key)
	Recursive method for setting array. More...

void	assign (const JMultiKey< 1, T > &key)
	Termination method for setting array. More...

void	assign (const JMultiKey< 1, const T > &key)
	Termination method for setting array. More...

template<unsigned int M>
void	assign (const JMultiKey< M, T > &key, argument_type value)
	Recursive method for setting array. More...

template<unsigned int M>
void	assign (const JMultiKey< M, const T > &key, argument_type value)
	Recursive method for setting array. More...

void	assign (const JMultiKey< 1, T > &key, argument_type value)
	Termination method for setting array. More...

void	assign (const JMultiKey< 1, const T > &key, argument_type value)
	Termination method for setting array. More...

Protected Attributes
T	buffer [N]

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<unsigned int N, class T>
class JTOOLS::JArray< N, T >

One dimensional array of template objects with fixed length.

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

Definition at line 35 of file JArray.hh.

Member Typedef Documentation

template<unsigned int N, class T>

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

Definition at line 41 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 42 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 43 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 44 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 45 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 46 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 47 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 48 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 49 of file JArray.hh.

template<unsigned int N, class T>

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

Definition at line 50 of file JArray.hh.

Constructor & Destructor Documentation

template<unsigned int N, class T>

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

inline

Default constructor.

Definition at line 56 of file JArray.hh.

57 {}

template<unsigned int N, class T>

template<unsigned int M>

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

inline

Copy constructor.

Parameters

array array

Definition at line 66 of file JArray.hh.

     {
       STATIC_CHECK(M >= N);
 
       std::copy_n(array.data(), N, this->data());
     }

template<unsigned int N, class T>

template<unsigned int M>

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

inline

Copy constructor.

Parameters

array array

Definition at line 80 of file JArray.hh.

     {
       STATIC_CHECK(M >= N);
  
       std::copy_n(array.data(), N, this->data());
     }

template<unsigned int N, class T>

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

inline

Copy constructor.

Parameters

p	pointer to data

Definition at line 93 of file JArray.hh.

     {
       std::copy_n(p, N, this->data());
     }

template<unsigned int N, class T>

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

inline

Copy constructor.

Parameters

key	multi-dimensional key

Definition at line 104 of file JArray.hh.

     {
       assign(key);
     }

template<unsigned int N, class T>

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

inline

Copy constructor.

Parameters

key	multi-dimensional key

Definition at line 115 of file JArray.hh.

     {
       assign(key);
     }

template<unsigned int N, class T>

JTOOLS::JArray< N, T >::JArray	(	const JArray< N-1, T > &	array,
		argument_type	value
	)

inline

Append constructor.

Parameters

array	array
value	value

Definition at line 127 of file JArray.hh.

     {
       std::copy_n(array.data(), N-1, this->data());
 
       this->buffer[N-1] = value;
     }

template<unsigned int N, class T>

JTOOLS::JArray< N, T >::JArray	(	const JArray< N-1, const T > &	array,
		argument_type	value
	)

inline

Append constructor.

Parameters

array	array
value	value

Definition at line 141 of file JArray.hh.

     {
       std::copy_n(array.data(), N-1, this->data());
 
       this->buffer[N-1] = value;
     }

template<unsigned int N, class T>

JTOOLS::JArray< N, T >::JArray	(	const JMultiKey< N-1, T > &	key,
		argument_type	value
	)

inline

Append constructor.

Parameters

key	multi-dimensional key
value	value

Definition at line 155 of file JArray.hh.

     {
       assign(key, value);
     }

template<unsigned int N, class T>

JTOOLS::JArray< N, T >::JArray	(	const JMultiKey< N-1, const T > &	key,
		argument_type	value
	)

inline

Append constructor.

Parameters

key	multi-dimensional key
value	value

Definition at line 167 of file JArray.hh.

     {
       assign(key, value);
     }

template<unsigned int N, class T>

template<class... Args>

JTOOLS::JArray< N, T >::JArray ( const Args &... args )

inline

Initialise constructor.

Parameters

args values

Definition at line 179 of file JArray.hh.

     {
       set(args...);
     }

Member Function Documentation

template<unsigned int N, class T>

template<class... Args>

JArray& JTOOLS::JArray< N, T >::set ( const Args &... args )

inline

Set array.

Parameters

args values

Definition at line 191 of file JArray.hh.

     {
       STATIC_CHECK(N == sizeof...(Args));
 
       __set__(0, args...);
 
       return *this;
     }

template<unsigned int N, class T>

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

inline

get iterator to begin of data

Definition at line 201 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get iterator to end of data

Definition at line 202 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get iterator to begin of data

Definition at line 205 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get iterator to end of data

Definition at line 206 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get reverse iterator to begin of data

Definition at line 209 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get reverse iterator to begin of data

Definition at line 210 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get reverse iterator to begin of data

Definition at line 213 of file JArray.hh.

template<unsigned int N, class T>

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

inline

get reverse iterator to end of data

Definition at line 214 of file JArray.hh.

template<unsigned int N, class T>

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

inline

Get element at given index.

Parameters

index index

Returns: element

Definition at line 223 of file JArray.hh.

     { 
       return buffer[index];
     }

template<unsigned int N, class T>

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

inline

Get element at given index.

Parameters

index index

Returns: element

Definition at line 235 of file JArray.hh.

     {
       return buffer[index];
     }

template<unsigned int N, class T>

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

inline

Get element at given index.

Parameters

index index

Returns: element at index

Definition at line 247 of file JArray.hh.

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

template<unsigned int N, class T>

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

inline

Get element at given index.

Parameters

index index

Returns: element at index

Definition at line 262 of file JArray.hh.

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

template<unsigned int N, class T>

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

inline

Get pointer to data.

Returns: pointer to data

Definition at line 276 of file JArray.hh.

     { 
       return buffer;
     }

template<unsigned int N, class T>

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

inline

Get pointer to data.

Returns: pointer to data

Definition at line 287 of file JArray.hh.

     { 
       return buffer;
     }

template<unsigned int N, class T>

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

inlinestatic

Get size of data.

Returns: size of data

Definition at line 298 of file JArray.hh.

     { 
       return N;
     }

template<unsigned int N, class T>

JArray<N-1, T> JTOOLS::JArray< N, T >::pop_front ( ) const

inline

Make a copy in which the first element is removed.

Returns: array

Definition at line 309 of file JArray.hh.

     {
       return JArray<N-1, T>(&buffer[1]);
     }

template<unsigned int N, class T>

JArray<N-1, T> JTOOLS::JArray< N, T >::pop_back ( ) const

inline

Make a copy in which the last element is removed.

Returns: array

Definition at line 320 of file JArray.hh.

     {
       return JArray<N-1, T>(buffer);
     }

template<unsigned int N, class T>

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

inline

Negate array.

Returns: this array

Definition at line 331 of file JArray.hh.

     {
       for (int i = 0; i != N; ++i) {
         buffer[i] = -buffer[i];
       }
 
       return *this;
     }

template<unsigned int N, class T>

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

inline

Add array.

Parameters

array array

Returns: this array

Definition at line 347 of file JArray.hh.

     {
       for (int i = 0; i != N; ++i) {
         buffer[i] += array[i];
       }
 
       return *this;
     }

template<unsigned int N, class T>

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

inline

Subtract array.

Parameters

array array

Returns: this array

Definition at line 363 of file JArray.hh.

     {
       for (int i = 0; i != N; ++i) {
         buffer[i] -= array[i];
       }
 
       return *this;
     }

template<unsigned int N, class T>

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

inline

Scale array.

Parameters

factor multiplication factor

Returns: this array

Definition at line 379 of file JArray.hh.

     {
       for (int i = 0; i != N; ++i) {
         buffer[i] *= factor;
       }
 
       return *this;
     }

template<unsigned int N, class T>

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

inline

Scale array.

Parameters

factor division factor

Returns: this array

Definition at line 395 of file JArray.hh.

     {
       for (int i = 0; i != N; ++i) {
         buffer[i] /= factor;
       }
 
       return *this;
     }

template<unsigned int N, class T>

bool JTOOLS::JArray< N, 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 411 of file JArray.hh.

     {
       for (int i = 0; i != N; ++i) {
         if (buffer[i] != array[i]) {
           return false;
         }
       }
 
       return true;
     }

template<unsigned int N, class T>

template<class... Args>

void JTOOLS::JArray< N, T >::__set__	(	const int	i,
		const argument_type	x,
		const Args &...	args
	)

inlineprotected

Recursive method for setting array.

Parameters

i	index
x	value at given index
args	remaining values

Definition at line 469 of file JArray.hh.

     {
       this->buffer[i] = x;
 
       __set__(i + 1, args...);
     }

template<unsigned int N, class T>

void JTOOLS::JArray< N, T >::__set__ ( const int i ) const

inlineprotected

Termination method for setting array.

Parameters

i index

Definition at line 482 of file JArray.hh.

483 {}

template<unsigned int N, class T>

template<unsigned int M>

void JTOOLS::JArray< N, T >::assign ( const JMultiKey< M, T > & key )

inlineprotected

Recursive method for setting array.

Parameters

key	multi-dimensional key

Definition at line 492 of file JArray.hh.

     {
       buffer[N-M] = key.first;
 
       assign(key.second);
     }

template<unsigned int N, class T>

template<unsigned int M>

void JTOOLS::JArray< N, T >::assign ( const JMultiKey< M, const T > & key )

inlineprotected

Recursive method for setting array.

Parameters

key	multi-dimensional key

Definition at line 506 of file JArray.hh.

     {
       buffer[N-M] = key.first;
 
       assign(key.second);
     }

template<unsigned int N, class T>

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

inlineprotected

Termination method for setting array.

Parameters

key	one-dimensional key

Definition at line 519 of file JArray.hh.

     {
       buffer[N-1] = key.first;
     }

template<unsigned int N, class T>

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

inlineprotected

Termination method for setting array.

Parameters

key	one-dimensional key

Definition at line 530 of file JArray.hh.

     {
       buffer[N-1] = key.first;
     }

template<unsigned int N, class T>

template<unsigned int M>

void JTOOLS::JArray< N, T >::assign	(	const JMultiKey< M, T > &	key,
		argument_type	value
	)

inlineprotected

Recursive method for setting array.

Parameters

key	multi-dimensional key
value	value

Definition at line 543 of file JArray.hh.

     {
       buffer[N-M-1] = key.first;
 
       assign(key.second, value);
     }

template<unsigned int N, class T>

template<unsigned int M>

void JTOOLS::JArray< N, T >::assign	(	const JMultiKey< M, const T > &	key,
		argument_type	value
	)

inlineprotected

Recursive method for setting array.

Parameters

key	multi-dimensional key
value	value

Definition at line 558 of file JArray.hh.

     {
       buffer[N-M-1] = key.first;
 
       assign(key.second, value);
     }

template<unsigned int N, class T>

void JTOOLS::JArray< N, T >::assign	(	const JMultiKey< 1, T > &	key,
		argument_type	value
	)

inlineprotected

Termination method for setting array.

Parameters

key	one-dimensional key
value	value

Definition at line 572 of file JArray.hh.

     {
       buffer[N-2] = key.first;
       buffer[N-1] = value;
     }

template<unsigned int N, class T>

void JTOOLS::JArray< N, T >::assign	(	const JMultiKey< 1, const T > &	key,
		argument_type	value
	)

inlineprotected

Termination method for setting array.

Parameters

key	one-dimensional key
value	value

Definition at line 585 of file JArray.hh.

     {
       buffer[N-2] = key.first;
       buffer[N-1] = value;
     }

JArray< N, T > & JMATH::JMath< JArray< N, 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<unsigned int N, class T>

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

friend

Read array from input.

Parameters

in	reader
buffer	array

Returns: reader

Definition at line 430 of file JArray.hh.

     {
       for (iterator i = buffer.begin(); i != buffer.end(); ++i) {
         in >> *i;
       }
 
       return in;
     }

template<unsigned int N, class T>

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

friend

Write array to output.

Parameters

out	writer
buffer	array

Returns: writer

Definition at line 447 of file JArray.hh.

     {
       for (const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
         out << *i;
       }
 
       return out;
     }

Member Data Documentation

template<unsigned int N, class T>

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

protected

Definition at line 458 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

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<unsigned int N, class T> class JTOOLS::JArray< N, T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<unsigned int N, class T>
class JTOOLS::JArray< N, T >