TPIE

11a2c2d
tpie::array_view< const T > Class Template Reference

Inherits tpie::array_view_base< const T >.

Public Types

typedef const T value_type
 Type of values contained in the array. More...
 

Public Member Functions

 array_view (array_view< T > o)
 
template<typename A >
 array_view (const std::vector< T, A > &v)
 
 array_view (const tpie::array< T > &v)
 
 array_view (const tpie::internal_vector< T > &v)
 
template<typename A >
 array_view (const std::vector< T, A > &v, size_t start, size_t end)
 
 array_view (const tpie::array< T > &v, size_t start, size_t end)
 
 array_view (const T *start, const T *end)
 
 array_view (const T *start, size_t size)
 
iterator find (size_t idx) const throw ()
 Return an iterator to the i'th element of the array. More...
 
const T & at (size_t i) const throw ()
 Return the element located at the given index. More...
 
bool empty () const
 Check if the array is empty. More...
 
size_t size () const
 Get number of elements in the array. More...
 
const T & operator[] (size_t i) const
 Return a reference to an array entry. More...
 
bool operator== (const array_view_base &other) const
 Check if the other array has the same elements in the same order as this. More...
 
bool operator!= (const array_view_base &other) const
 Check if the two arrays differ. More...
 
iterator begin () const
 Return an iterator to the beginning of the array. More...
 
iterator end () const
 Return an iterator to the end of the array. More...
 
const T & front () const
 Return the first element in the array. More...
 
const T & back () const
 Return the last element in the array. More...
 

Detailed Description

template<typename T>
class tpie::array_view< const T >

Definition at line 111 of file array_view.h.

Member Typedef Documentation

◆ value_type

typedef const T tpie::array_view_base< const T >::value_type
inherited

Type of values contained in the array.

Definition at line 74 of file array_view_base.h.

Member Function Documentation

◆ at()

const T & tpie::array_view_base< const T >::at ( size_t  i) const
throw (
)
inlineinherited

Return the element located at the given index.

Parameters
iThe index of the element returned.

Definition at line 92 of file array_view_base.h.

92  {
93  assert(i < size());
94  return *find(i);
95  }

◆ back()

const T & tpie::array_view_base< const T >::back
inlineinherited

Return the last element in the array.

Definition at line 168 of file array_view_base.h.

168 {return *(m_end-1);}

◆ begin()

iterator tpie::array_view_base< const T >::begin
inlineinherited

Return an iterator to the beginning of the array.

Returns
An iterator to the beginning of the array.

Definition at line 151 of file array_view_base.h.

151 {return iterator(m_start);}

◆ empty()

bool tpie::array_view_base< const T >::empty
inlineinherited

Check if the array is empty.

Returns
True if and only if size is 0.

Definition at line 102 of file array_view_base.h.

102 {return m_end == m_start;}

◆ end()

iterator tpie::array_view_base< const T >::end
inlineinherited

Return an iterator to the end of the array.

Returns
An iterator to the end of the array.

Definition at line 158 of file array_view_base.h.

158 {return iterator(m_end);}

◆ find()

iterator tpie::array_view_base< const T >::find ( size_t  idx) const
throw (
)
inlineinherited

Return an iterator to the i'th element of the array.

Parameters
idxThe index of the element we want an iterator to.
Returns
An iterator to the i'th element.

Definition at line 82 of file array_view_base.h.

82  {
83  assert(idx <= size());
84  return iterator(m_start + idx);
85  }

◆ front()

const T & tpie::array_view_base< const T >::front
inlineinherited

Return the first element in the array.

Definition at line 163 of file array_view_base.h.

163 {return *m_start;}

◆ operator!=()

bool tpie::array_view_base< const T >::operator!= ( const array_view_base< const T > &  other) const
inlineinherited

Check if the two arrays differ.

Parameters
otherThe array to compare against.
Returns
false If they are equal otherwise true.

Definition at line 140 of file array_view_base.h.

140  {
141  if (size() != other.size()) return true;
142  for (size_t i=0; i< size(); ++i) if (at(i) != other.at(i)) return true;
143  return false;
144  }

◆ operator==()

bool tpie::array_view_base< const T >::operator== ( const array_view_base< const T > &  other) const
inlineinherited

Check if the other array has the same elements in the same order as this.

Parameters
otherThe array to compare against.
Returns
True if they are equal, otherwise false.

Definition at line 128 of file array_view_base.h.

128  {
129  if (size() != other.size()) return false;
130  for (size_t i=0; i < size(); ++i) if (at(i) != other.at(i)) return false;
131  return true;
132  }

◆ operator[]()

const T & tpie::array_view_base< const T >::operator[] ( size_t  i) const
inlineinherited

Return a reference to an array entry.

Parameters
iThe index of the entry to return.
Returns
Reference to the entry.

Definition at line 116 of file array_view_base.h.

116  {
117  assert(i < size());
118  return at(i);
119  }

◆ size()

size_t tpie::array_view_base< const T >::size
inlineinherited

Get number of elements in the array.

Returns
Number of elements in the array.

Definition at line 108 of file array_view_base.h.

108 {return m_end - m_start;}

The documentation for this class was generated from the following file:
tpie::array_view_base< const T >::at
const T & at(size_t i) const
Return the element located at the given index.
Definition: array_view_base.h:92
tpie::array_view_base< const T >::size
size_t size() const
Get number of elements in the array.
Definition: array_view_base.h:108
tpie::array_view_base< const T >::find
iterator find(size_t idx) const
Return an iterator to the i'th element of the array.
Definition: array_view_base.h:82