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 (const T *p)
	Copy constructor. More...

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

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

	JArray (argument_type value)
	Initialise 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...

void	fill (argument_type value)
	Fill array. 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...

JFirst_t &	mul (const JSecond_t &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
std::istream &	operator>> (std::istream &in, JArray &array)
	Read array from input stream. More...

std::ostream &	operator<< (std::ostream &out, const JArray &array)
	Write array to output stream. More...

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 653 of file JArray.hh.

Member Typedef Documentation

◆ const_pointer

template<class T >

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

Definition at line 661 of file JArray.hh.

◆ pointer

template<class T >

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

Definition at line 662 of file JArray.hh.

◆ const_iterator

template<class T >

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

Definition at line 663 of file JArray.hh.

◆ iterator

template<class T >

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

Definition at line 664 of file JArray.hh.

◆ const_reverse_iterator

template<class T >

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

Definition at line 665 of file JArray.hh.

◆ reverse_iterator

template<class T >

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

Definition at line 666 of file JArray.hh.

◆ reference

template<class T >

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

Definition at line 667 of file JArray.hh.

◆ const_reference

template<class T >

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

Definition at line 668 of file JArray.hh.

◆ size_type

template<class T >

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

Definition at line 669 of file JArray.hh.

◆ argument_type

template<class T >

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

Definition at line 670 of file JArray.hh.

Constructor & Destructor Documentation

◆ JArray() [1/7]

template<class T >

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

inline

Default constructor.

Definition at line 676 of file JArray.hh.

     {
       fill(T());
     }

◆ JArray() [2/7]

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 688 of file JArray.hh.

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

◆ JArray() [3/7]

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 700 of file JArray.hh.

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

◆ JArray() [4/7]

template<class T >

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

inline

Copy constructor.

Parameters

p	pointer to data

Definition at line 711 of file JArray.hh.

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

◆ JArray() [5/7]

template<class T >

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

inline

Copy constructor.

Parameters

key	multi-dimensional key

Definition at line 722 of file JArray.hh.

     {
       buffer[0] = key.first;
     }

◆ JArray() [6/7]

template<class T >

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

inline

Copy constructor.

Parameters

key	multi-dimensional key

Definition at line 733 of file JArray.hh.

     {
       buffer[0] = key.first;
     }

◆ JArray() [7/7]

template<class T >

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

inline

Initialise constructor.

Parameters

value value;

Definition at line 744 of file JArray.hh.

     {
       buffer[0] = value;
     }

Member Function Documentation

◆ begin() [1/2]

template<class T >

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

inline

get iterator to begin of data

Definition at line 750 of file JArray.hh.

◆ end() [1/2]

template<class T >

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

inline

get iterator to end of data

Definition at line 751 of file JArray.hh.

◆ begin() [2/2]

template<class T >

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

inline

get iterator to begin of data

Definition at line 754 of file JArray.hh.

◆ end() [2/2]

template<class T >

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

inline

get iterator to end of data

Definition at line 755 of file JArray.hh.

◆ rbegin() [1/2]

template<class T >

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

inline

get reverse iterator to begin of data

Definition at line 758 of file JArray.hh.

◆ rend() [1/2]

template<class T >

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

inline

get reverse iterator to begin of data

Definition at line 759 of file JArray.hh.

◆ rbegin() [2/2]

template<class T >

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

inline

get reverse iterator to begin of data

Definition at line 762 of file JArray.hh.

◆ rend() [2/2]

template<class T >

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

inline

get reverse iterator to end of data

Definition at line 763 of file JArray.hh.

◆ operator[]() [1/2]

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 772 of file JArray.hh.

     { 
       return buffer[index];
     }

◆ operator[]() [2/2]

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 784 of file JArray.hh.

     {
       return buffer[index];
     }

◆ at() [1/2]

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 796 of file JArray.hh.

     { 
       if (index == 0)
         return buffer[index];
       else
         THROW(JIndexOutOfRange, "invalid index " << 0 << " <= " << index << " < " << N);
     }

◆ at() [2/2]

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 811 of file JArray.hh.

     { 
       if (index == 0)
         return buffer[index];
       else
         THROW(JIndexOutOfRange, "invalid index " << 0 << " <= " << index << " < " << N);
     }

◆ data() [1/2]

template<class T >

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

inline

Get pointer to data.

Returns: pointer to data

Definition at line 825 of file JArray.hh.

     { 
       return buffer;
     }

◆ data() [2/2]

template<class T >

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

inline

Get pointer to data.

Returns: pointer to data

Definition at line 836 of file JArray.hh.

     { 
       return buffer;
     }

◆ size()

template<class T >

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

inlinestatic

Get size of data.

Returns: size of data

Definition at line 847 of file JArray.hh.

     { 
       return N;
     }

◆ fill()

template<class T >

void JTOOLS::JArray< 1, T >::fill ( argument_type value )

inline

Fill array.

Parameters

value value

Definition at line 858 of file JArray.hh.

     {
       buffer[0] = value;
     }

◆ negate()

template<class T >

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

inline

Negate array.

Returns: this array

Definition at line 869 of file JArray.hh.

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

◆ add()

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 883 of file JArray.hh.

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

◆ sub()

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 897 of file JArray.hh.

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

◆ mul() [1/2]

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 911 of file JArray.hh.

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

◆ div()

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 925 of file JArray.hh.

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

◆ equals()

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 939 of file JArray.hh.

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

◆ 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,
		JArray< 1, T > &	array
	)

friend

Read array from input stream.

Parameters

in	input stream
array	array

Returns: input stream

Definition at line 952 of file JArray.hh.

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

◆ operator<< [1/2]

template<class T >

std::ostream& operator<<	(	std::ostream &	out,
		const JArray< 1, T > &	array
	)

friend

Write array to output stream.

Parameters

out	output stream
array	array

Returns: output stream

Definition at line 969 of file JArray.hh.

     {
       for (const_iterator i = array.begin(); i != array.end(); ++i) {
         out << ' ' << SCIENTIFIC(12,5) << *i;
       }
  
       return out;
     }

◆ operator>> [2/2]

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 986 of file JArray.hh.

     {
       return in >> buffer[0];
     }

◆ operator<< [2/2]

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 999 of file JArray.hh.

     {
       return out << buffer[0];
     }

Member Data Documentation

◆ N

template<class T >

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

static

Definition at line 659 of file JArray.hh.

◆ buffer

template<class T >

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

protected

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

◆ const_pointer

◆ pointer

◆ const_iterator

◆ iterator

◆ const_reverse_iterator

◆ reverse_iterator

◆ reference

◆ const_reference

◆ size_type

◆ argument_type

Constructor & Destructor Documentation

◆ JArray() [1/7]

◆ JArray() [2/7]

◆ JArray() [3/7]

◆ JArray() [4/7]

◆ JArray() [5/7]

◆ JArray() [6/7]

◆ JArray() [7/7]

Member Function Documentation

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]

◆ rbegin() [1/2]

◆ rend() [1/2]

◆ rbegin() [2/2]

◆ rend() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ size()

◆ fill()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ equals()

◆ mul() [2/2]

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ N

◆ buffer

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