Jpp - 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 | Protected Member Functions | Protected Attributes | Friends | List of all members
JTOOLS::JArray< N, const T > Class Template Reference

One dimensional read-only array of template objects with fixed length. More...

#include <JArray.hh>

Public Types

typedef const Tconst_pointer
 
typedef const Tconst_iterator
 
typedef std::reverse_iterator
< const_iterator
const_reverse_iterator
 
typedef const Tconst_reference
 
typedef unsigned int size_type
 

Public Member Functions

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...
 
const_iterator begin () const
 get iterator to begin of data More...
 
const_iterator end () const
 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 end of data More...
 
const_reference operator[] (int index) const
 Get element at given index. More...
 
const_reference at (int index) const
 Get element at given index. More...
 
const_pointer data () const
 Get pointer to data. More...
 
JArray< N-1, const Tpop_front () const
 Make a copy in which the first element is removed. More...
 
JArray< N-1, const Tpop_back () const
 Make a copy in which the last element is removed. More...
 

Static Public Member Functions

static size_type size ()
 Get size of data. More...
 

Protected Member Functions

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

Protected Attributes

const_pointer p
 

Friends

class JArray< N+1, const T >
 
JWriteroperator<< (JWriter &out, const JArray &buffer)
 Write array to output. More...
 

Detailed Description

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

One dimensional read-only array of template objects with fixed length.

The internal data structure consists of a simple C-pointer to the actual data. The user should ensure that the data are persistent.

Definition at line 987 of file JArray.hh.

Member Typedef Documentation

template<unsigned int N, class T >
typedef const T* JTOOLS::JArray< N, const T >::const_pointer

Definition at line 992 of file JArray.hh.

template<unsigned int N, class T >
typedef const T* JTOOLS::JArray< N, const T >::const_iterator

Definition at line 993 of file JArray.hh.

template<unsigned int N, class T >
typedef std::reverse_iterator<const_iterator> JTOOLS::JArray< N, const T >::const_reverse_iterator

Definition at line 994 of file JArray.hh.

template<unsigned int N, class T >
typedef const T& JTOOLS::JArray< N, const T >::const_reference

Definition at line 995 of file JArray.hh.

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

Definition at line 996 of file JArray.hh.

Constructor & Destructor Documentation

template<unsigned int N, class T >
template<unsigned int M>
JTOOLS::JArray< N, const T >::JArray ( const JArray< M, T > &  array)
inline

Copy constructor.

Parameters
arrayarray

Definition at line 1005 of file JArray.hh.

1005  :
1006  p(array.data())
1007  {
1008  STATIC_CHECK(M >= N);
1009  }
do $JPP JMEstimator M
Definition: JMEstimator.sh:37
#define STATIC_CHECK(expr)
Definition: JAssert.hh:29
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:35
const_pointer data() const
Get pointer to data.
Definition: JArray.hh:282
template<unsigned int N, class T >
template<unsigned int M>
JTOOLS::JArray< N, const T >::JArray ( const JArray< M, const T > &  array)
inline

Copy constructor.

Parameters
arrayarray

Definition at line 1018 of file JArray.hh.

1018  :
1019  p(array.data())
1020  {
1021  STATIC_CHECK(M >= N);
1022  }
do $JPP JMEstimator M
Definition: JMEstimator.sh:37
#define STATIC_CHECK(expr)
Definition: JAssert.hh:29
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:35
const_pointer data() const
Get pointer to data.
Definition: JArray.hh:282
template<unsigned int N, class T >
JTOOLS::JArray< N, const T >::JArray ( const T __p)
inlineprotected

Constructor.

Parameters
__ppointer to data

Definition at line 1129 of file JArray.hh.

1129  :
1130  p(__p)
1131  {}

Member Function Documentation

template<unsigned int N, class T >
const_iterator JTOOLS::JArray< N, const T >::begin ( ) const
inline

get iterator to begin of data

Definition at line 1025 of file JArray.hh.

template<unsigned int N, class T >
const_iterator JTOOLS::JArray< N, const T >::end ( ) const
inline

get iterator to end of data

Definition at line 1026 of file JArray.hh.

template<unsigned int N, class T >
const_reverse_iterator JTOOLS::JArray< N, const T >::rbegin ( ) const
inline

get reverse iterator to begin of data

Definition at line 1029 of file JArray.hh.

template<unsigned int N, class T >
const_reverse_iterator JTOOLS::JArray< N, const T >::rend ( ) const
inline

get reverse iterator to end of data

Definition at line 1030 of file JArray.hh.

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

Get element at given index.

Parameters
indexindex
Returns
element at index

Definition at line 1039 of file JArray.hh.

1040  {
1041  return p[index];
1042  }
template<unsigned int N, class T >
const_reference JTOOLS::JArray< N, const T >::at ( int  index) const
inline

Get element at given index.

Parameters
indexindex
Returns
element at index

Definition at line 1051 of file JArray.hh.

1052  {
1053  if (index >= 0 && index < N)
1054  return p[index];
1055  else
1056  throw JIndexOutOfRange("JArray<>::at()");
1057  }
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:35
template<unsigned int N, class T >
const_pointer JTOOLS::JArray< N, const T >::data ( ) const
inline

Get pointer to data.

Returns
pointer to data

Definition at line 1065 of file JArray.hh.

1066  {
1067  return p;
1068  }
template<unsigned int N, class T >
static size_type JTOOLS::JArray< N, const T >::size ( )
inlinestatic

Get size of data.

Returns
size of data

Definition at line 1076 of file JArray.hh.

1077  {
1078  return N;
1079  }
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:35
template<unsigned int N, class T >
JArray<N-1, const T> JTOOLS::JArray< N, const T >::pop_front ( ) const
inline

Make a copy in which the first element is removed.

Returns
array

Definition at line 1087 of file JArray.hh.

1088  {
1089  return JArray<N-1, const T>(p + 1);
1090  }
do set_variable OUTPUT_DIRECTORY $WORKDIR T
One dimensional array of template objects with fixed length.
Definition: JArray.hh:40
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:35
template<unsigned int N, class T >
JArray<N-1, const T> JTOOLS::JArray< N, const T >::pop_back ( ) const
inline

Make a copy in which the last element is removed.

Returns
array

Definition at line 1098 of file JArray.hh.

1099  {
1100  return JArray<N-1, const T>(p);
1101  }
do set_variable OUTPUT_DIRECTORY $WORKDIR T
One dimensional array of template objects with fixed length.
Definition: JArray.hh:40
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:35

Friends And Related Function Documentation

template<unsigned int N, class T >
friend class JArray< N+1, const T >
friend

Definition at line 990 of file JArray.hh.

template<unsigned int N, class T >
JWriter& operator<< ( JWriter out,
const JArray< N, const T > &  buffer 
)
friend

Write array to output.

Parameters
outwriter
bufferarray
Returns
writer

Definition at line 1111 of file JArray.hh.

1112  {
1113  for (const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
1114  out << *i;
1115  }
1116 
1117  return out;
1118  }
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

Member Data Documentation

template<unsigned int N, class T >
const_pointer JTOOLS::JArray< N, const T >::p
protected

Definition at line 1122 of file JArray.hh.


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