Jpp  15.0.1
the software that should make you happy
 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< JFirst_t, JSecond_t > JLANG::JEquals< JFirst_t, JSecond_t >

Public Types

typedef const Tconst_pointer
 
typedef Tpointer
 
typedef const Tconst_iterator
 
typedef Titerator
 
typedef std::reverse_iterator
< const_iterator
const_reverse_iterator
 
typedef std::reverse_iterator
< iterator
reverse_iterator
 
typedef Treference
 
typedef const Tconst_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 x)
 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...
 
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...
 
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...
 
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 638 of file JArray.hh.

Member Typedef Documentation

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

Definition at line 646 of file JArray.hh.

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

Definition at line 647 of file JArray.hh.

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

Definition at line 648 of file JArray.hh.

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

Definition at line 649 of file JArray.hh.

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

Definition at line 650 of file JArray.hh.

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

Definition at line 651 of file JArray.hh.

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

Definition at line 652 of file JArray.hh.

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

Definition at line 653 of file JArray.hh.

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

Definition at line 654 of file JArray.hh.

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

Definition at line 655 of file JArray.hh.

Constructor & Destructor Documentation

template<class T >
JTOOLS::JArray< 1, T >::JArray ( )
inline

Default constructor.

Definition at line 661 of file JArray.hh.

662  {}
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 671 of file JArray.hh.

672  {
673  buffer[0] = array[0];
674  }
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 683 of file JArray.hh.

684  {
685  buffer[0] = array[0];
686  }
template<class T >
JTOOLS::JArray< 1, T >::JArray ( const T p)
inline

Copy constructor.

Parameters
ppointer to data

Definition at line 694 of file JArray.hh.

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

Copy constructor.

Parameters
keymulti-dimensional key

Definition at line 705 of file JArray.hh.

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

Copy constructor.

Parameters
keymulti-dimensional key

Definition at line 716 of file JArray.hh.

717  {
718  buffer[0] = key.first;
719  }
template<class T >
JTOOLS::JArray< 1, T >::JArray ( argument_type  x)
inline

Initialise constructor.

Parameters
xvalue;

Definition at line 727 of file JArray.hh.

728  {
729  buffer[0] = x;
730  }

Member Function Documentation

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

get iterator to begin of data

Definition at line 733 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 734 of file JArray.hh.

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

get iterator to begin of data

Definition at line 737 of file JArray.hh.

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

get iterator to end of data

Definition at line 738 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 741 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 742 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 745 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 746 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 755 of file JArray.hh.

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

Get element at given index.

Parameters
indexindex
Returns
element

Definition at line 767 of file JArray.hh.

768  {
769  return buffer[index];
770  }
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 779 of file JArray.hh.

780  {
781  if (index >= 0 && index < N)
782  return buffer[index];
783  else
784  throw JIndexOutOfRange("JArray<>::at()");
785  }
static const unsigned int N
Definition: JArray.hh:644
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 794 of file JArray.hh.

795  {
796  if (index >= 0 && index < N)
797  return buffer[index];
798  else
799  throw JIndexOutOfRange("JArray<>::at()");
800  }
static const unsigned int N
Definition: JArray.hh:644
template<class T >
const_pointer JTOOLS::JArray< 1, T >::data ( ) const
inline

Get pointer to data.

Returns
pointer to data

Definition at line 808 of file JArray.hh.

809  {
810  return buffer;
811  }
template<class T >
pointer JTOOLS::JArray< 1, T >::data ( )
inline

Get pointer to data.

Returns
pointer to data

Definition at line 819 of file JArray.hh.

820  {
821  return buffer;
822  }
template<class T >
static size_type JTOOLS::JArray< 1, T >::size ( )
inlinestatic

Get size of data.

Returns
size of data

Definition at line 830 of file JArray.hh.

831  {
832  return N;
833  }
static const unsigned int N
Definition: JArray.hh:644
template<class T >
JArray& JTOOLS::JArray< 1, T >::negate ( )
inline

Negate array.

Returns
this array

Definition at line 841 of file JArray.hh.

842  {
843  buffer[0] = -buffer[0];
844 
845  return *this;
846  }
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 855 of file JArray.hh.

856  {
857  buffer[0] += array[0];
858 
859  return *this;
860  }
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 869 of file JArray.hh.

870  {
871  buffer[0] -= array[0];
872 
873  return *this;
874  }
template<class T >
JArray& JTOOLS::JArray< 1, T >::mul ( const double  factor)
inline

Scale array.

Parameters
factormultiplication factor
Returns
this array

Definition at line 883 of file JArray.hh.

884  {
885  buffer[0] *= factor;
886 
887  return *this;
888  }
template<class T >
JArray& JTOOLS::JArray< 1, T >::div ( const double  factor)
inline

Scale array.

Parameters
factordivision factor
Returns
this array

Definition at line 897 of file JArray.hh.

898  {
899  buffer[0] /= factor;
900 
901  return *this;
902  }
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 911 of file JArray.hh.

912  {
913  return buffer[0] == array[0];
914  }
template<class JFirst_t, class JSecond_t = JNullType>
JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t &  object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 357 of file JMath.hh.

358  {
359  return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
360  }
Auxiliary class for arithmetic operations on objects.
Definition: JCalculator.hh:18

Friends And Related Function Documentation

template<class T >
std::istream& operator>> ( std::istream &  in,
JArray< 1, T > &  array 
)
friend

Read array from input stream.

Parameters
ininput stream
arrayarray
Returns
input stream

Definition at line 924 of file JArray.hh.

925  {
926  for (iterator i = array.begin(); i != array.end(); ++i) {
927  in >> *i;
928  }
929 
930  return in;
931  }
const_iterator begin() const
get iterator to begin of data
Definition: JArray.hh:207
const_iterator end() const
get iterator to end of data
Definition: JArray.hh:208
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
template<class T >
std::ostream& operator<< ( std::ostream &  out,
const JArray< 1, T > &  array 
)
friend

Write array to output stream.

Parameters
outoutput stream
arrayarray
Returns
output stream

Definition at line 941 of file JArray.hh.

942  {
943  for (const_iterator i = array.begin(); i != array.end(); ++i) {
944  out << ' ' << SCIENTIFIC(12,5) << *i;
945  }
946 
947  return out;
948  }
const T * const_iterator
Definition: JArray.hh:648
const_iterator begin() const
get iterator to begin of data
Definition: JArray.hh:207
const_iterator end() const
get iterator to end of data
Definition: JArray.hh:208
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:484
template<class T >
JReader& operator>> ( JReader in,
JArray< 1, T > &  buffer 
)
friend

Read array from input.

Parameters
inreader
bufferarray
Returns
reader

Definition at line 958 of file JArray.hh.

959  {
960  return in >> buffer[0];
961  }
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
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 971 of file JArray.hh.

972  {
973  return out << buffer[0];
974  }

Member Data Documentation

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

Definition at line 644 of file JArray.hh.

template<class T >
T JTOOLS::JArray< 1, T >::buffer[1]
protected

Definition at line 977 of file JArray.hh.


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