Jpp  18.6.0-rc.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 Member Functions | Protected Attributes | Friends | List of all members
JTOOLS::JArray< 1, 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...
 

Static Public Member Functions

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

Static Public Attributes

static const unsigned int N = 1
 

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<class T>
class JTOOLS::JArray< 1, 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 1169 of file JArray.hh.

Member Typedef Documentation

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

Definition at line 1176 of file JArray.hh.

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

Definition at line 1177 of file JArray.hh.

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

Definition at line 1178 of file JArray.hh.

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

Definition at line 1179 of file JArray.hh.

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

Definition at line 1180 of file JArray.hh.

Constructor & Destructor Documentation

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

Copy constructor.

Parameters
arrayarray

Definition at line 1189 of file JArray.hh.

1189  :
1190  p(array.data())
1191  {
1192  STATIC_CHECK(M >= N);
1193  }
static const unsigned int N
Definition: JArray.hh:1172
#define STATIC_CHECK(expr)
Definition: JAssert.hh:31
const_pointer data() const
Get pointer to data.
Definition: JArray.hh:284
template<class T >
template<unsigned int M>
JTOOLS::JArray< 1, const T >::JArray ( const JArray< M, const T > &  array)
inline

Copy constructor.

Parameters
arrayarray

Definition at line 1202 of file JArray.hh.

1202  :
1203  p(array.data())
1204  {
1205  STATIC_CHECK(M >= N);
1206  }
static const unsigned int N
Definition: JArray.hh:1172
#define STATIC_CHECK(expr)
Definition: JAssert.hh:31
const_pointer data() const
Get pointer to data.
Definition: JArray.hh:284
template<class T >
JTOOLS::JArray< 1, const T >::JArray ( const T __p)
inlineprotected

Constructor.

Parameters
__ppointer to data

Definition at line 1287 of file JArray.hh.

1287  :
1288  p(__p)
1289  {}

Member Function Documentation

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

get iterator to begin of data

Definition at line 1209 of file JArray.hh.

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

get iterator to end of data

Definition at line 1210 of file JArray.hh.

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

get reverse iterator to begin of data

Definition at line 1213 of file JArray.hh.

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

get reverse iterator to end of data

Definition at line 1214 of file JArray.hh.

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

Get element at given index.

Parameters
indexindex
Returns
element at index

Definition at line 1223 of file JArray.hh.

1224  {
1225  return p[index];
1226  }
template<class T >
const_reference JTOOLS::JArray< 1, const T >::at ( int  index) const
inline

Get element at given index.

Parameters
indexindex
Returns
element at index

Definition at line 1235 of file JArray.hh.

1236  {
1237  if (index >= 0 && index < N)
1238  return p[index];
1239  else
1240  THROW(JIndexOutOfRange, "invalid index " << 0 << " <= " << index << " < " << N);
1241  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
static const unsigned int N
Definition: JArray.hh:1172
template<class T >
const_pointer JTOOLS::JArray< 1, const T >::data ( ) const
inline

Get pointer to data.

Returns
pointer to data

Definition at line 1249 of file JArray.hh.

1250  {
1251  return p;
1252  }
template<class T >
static size_type JTOOLS::JArray< 1, const T >::size ( )
inlinestatic

Get size of data.

Returns
size of data

Definition at line 1260 of file JArray.hh.

1261  {
1262  return N;
1263  }
static const unsigned int N
Definition: JArray.hh:1172

Friends And Related Function Documentation

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

Definition at line 1174 of file JArray.hh.

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

Write array to output.

Parameters
outwriter
bufferarray
Returns
writer

Definition at line 1273 of file JArray.hh.

1274  {
1275  return out << buffer[0];
1276  }

Member Data Documentation

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

Definition at line 1172 of file JArray.hh.

template<class T >
const_pointer JTOOLS::JArray< 1, const T >::p
protected

Definition at line 1280 of file JArray.hh.


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