Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
JTOOLS::JArray< 1, T > Class Template Reference

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

#include <JArray.hh>

Inheritance diagram for JTOOLS::JArray< 1, T >:
JMATH::JMath< JArray< 1, T > > JLANG::JEquals< 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...
 
JArraynegate ()
 Negate array. More...
 
JArrayadd (const JArray &array)
 Add array. More...
 
JArraysub (const JArray &array)
 Subtract array. More...
 
JArraymul (const double factor)
 Scale array. More...
 
JArraydiv (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

buffer [1]
 

Friends

JReaderoperator>> (JReader &in, JArray &buffer)
 Read array from input. More...
 
JWriteroperator<< (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
arrayarray

Definition at line 524 of file JArray.hh.

525  {
526  buffer[0] = array[0];
527  }
template<class T >
template<unsigned int M>
JTOOLS::JArray< 1, T >::JArray ( const JArray< M, const T > &  array)
inline

Copy constructor.

Parameters
arrayarray

Definition at line 536 of file JArray.hh.

537  {
538  buffer[0] = array[0];
539  }
template<class T >
JTOOLS::JArray< 1, T >::JArray ( argument_type  x)
inline

Initialise constructor.

Parameters
xvalue;

Definition at line 547 of file JArray.hh.

548  {
549  buffer[0] = x;
550  }
template<class T >
JTOOLS::JArray< 1, T >::JArray ( const T *  p)
inline

Constructor.

Parameters
ppointer to data

Definition at line 558 of file JArray.hh.

559  {
560  buffer[0] = p[0];
561  }
template<class T >
JTOOLS::JArray< 1, T >::JArray ( const JMultiKey< 1, T > &  key)
inline

Constructor.

Parameters
keymulti-dimensional key

Definition at line 569 of file JArray.hh.

570  {
571  buffer[0] = key.first;
572  }
template<class T >
JTOOLS::JArray< 1, T >::JArray ( const JMultiKey< 1, const T > &  key)
inline

Constructor.

Parameters
keymulti-dimensional key

Definition at line 580 of file JArray.hh.

581  {
582  buffer[0] = key.first;
583  }

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
indexindex
Returns
element

Definition at line 608 of file JArray.hh.

609  {
610  return buffer[index];
611  }
template<class T >
reference JTOOLS::JArray< 1, T >::operator[] ( int  index)
inline

Get element at given index.

Parameters
indexindex
Returns
element

Definition at line 620 of file JArray.hh.

621  {
622  return buffer[index];
623  }
template<class T >
const_reference JTOOLS::JArray< 1, T >::at ( int  index) const
inline

Get element at given index.

Parameters
indexindex
Returns
element at index

Definition at line 632 of file JArray.hh.

633  {
634  if (index >= 0 && index < N)
635  return buffer[index];
636  else
637  throw JIndexOutOfRange("JArray<>::at()");
638  }
static const unsigned int N
Definition: JArray.hh:497
template<class T >
reference JTOOLS::JArray< 1, T >::at ( int  index)
inline

Get element at given index.

Parameters
indexindex
Returns
element at index

Definition at line 647 of file JArray.hh.

648  {
649  if (index >= 0 && index < N)
650  return buffer[index];
651  else
652  throw JIndexOutOfRange("JArray<>::at()");
653  }
static const unsigned int N
Definition: JArray.hh:497
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.

662  {
663  return buffer;
664  }
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.

673  {
674  return buffer;
675  }
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.

684  {
685  return N;
686  }
static const unsigned int N
Definition: JArray.hh:497
template<class T >
JArray& JTOOLS::JArray< 1, T >::negate ( )
inline

Negate array.

Returns
this array

Definition at line 694 of file JArray.hh.

695  {
696  buffer[0] = -buffer[0];
697 
698  return *this;
699  }
template<class T >
JArray& JTOOLS::JArray< 1, T >::add ( const JArray< 1, T > &  array)
inline

Add array.

Parameters
arrayarray
Returns
this array

Definition at line 708 of file JArray.hh.

709  {
710  buffer[0] += array[0];
711 
712  return *this;
713  }
template<class T >
JArray& JTOOLS::JArray< 1, T >::sub ( const JArray< 1, T > &  array)
inline

Subtract array.

Parameters
arrayarray
Returns
this array

Definition at line 722 of file JArray.hh.

723  {
724  buffer[0] -= array[0];
725 
726  return *this;
727  }
template<class T >
JArray& JTOOLS::JArray< 1, T >::mul ( const double  factor)
inline

Scale array.

Parameters
factormultiplication factor
Returns
this array

Definition at line 736 of file JArray.hh.

737  {
738  buffer[0] *= factor;
739 
740  return *this;
741  }
template<class T >
JArray& JTOOLS::JArray< 1, T >::div ( const double  factor)
inline

Scale array.

Parameters
factordivision factor
Returns
this array

Definition at line 750 of file JArray.hh.

751  {
752  buffer[0] /= factor;
753 
754  return *this;
755  }
template<class T >
bool JTOOLS::JArray< 1, T >::equals ( const JArray< N, T > &  array) const
inline

Check equality.

Parameters
arrayarray
Returns
true if arrays are equal; else false

Definition at line 764 of file JArray.hh.

765  {
766  return buffer[0] == array[0];
767  }
JArray< 1, T > & JMATH::JMath< JArray< 1, T > , JNullType >::mul ( const JNullType object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 273 of file JMath.hh.

274  {
275  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
276  }
Auxiliary class for product evaluation of objects.
Definition: JCalculator.hh:18

Friends And Related Function Documentation

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

Read array from input.

Parameters
inreader
bufferarray
Returns
reader

Definition at line 777 of file JArray.hh.

778  {
779  return in >> buffer[0];
780  }
template<class T >
JWriter& operator<< ( JWriter out,
const JArray< 1, T > &  buffer 
)
friend

Write array to output.

Parameters
outwriter
bufferarray
Returns
writer

Definition at line 790 of file JArray.hh.

791  {
792  return out << buffer[0];
793  }

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: