Detailed Description
template<typename T, std::size_t N>
class mrpt::utils::CArray< T, N >
A STL container (as wrapper) for arrays of constant size defined at compile time.
This code is an adapted version from Boost, modifed for its integration within MRPT (JLBC, Dec/2009) (Renamed array -> CArray to avoid possible potential conflicts).
See http://www.josuttis.com/cppcode for details and the latest version. See http://www.boost.org/libs/array for Documentation. for documentation.
(C) Copyright Nicolai M. Josuttis 2001. Permission to copy, use, modify, sell and distribute this software is granted provided this copyright notice appears in all copies. This software is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.
29 Jan 2004 - minor fixes (Nico Josuttis) 04 Dec 2003 - update to synch with library TR1 (Alisdair Meredith) 23 Aug 2002 - fix for Non-MSVC compilers combined with MSVC libraries. 05 Aug 2001 - minor update (Nico Josuttis) 20 Jan 2001 - STLport fix (Beman Dawes) 29 Sep 2000 - Initial Revision (Nico Josuttis)
Jan 30, 2004
- Note
- This class DOES NOT support mathematical operations on its elements: it's a generic container, it doesn't assume they are numerical.
- For a summary and classification of all MRPT vector, array and matrix classes see: http://www.mrpt.org/Matrices_vectors_arrays_and_Linear_Algebra_MRPT_and_Eigen_classes
- See also
- mrpt::math::CArrayNumeric (for another, non-related base template class that DOES support maths)
#include <mrpt/utils/CArray.h>
Public Types | |
| enum | { static_size = N } |
| typedef T | value_type |
| typedef T * | iterator |
| typedef const T * | const_iterator |
| typedef T & | reference |
| typedef const T & | const_reference |
| typedef std::size_t | size_type |
| typedef std::ptrdiff_t | difference_type |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Public Member Functions | |
| iterator | begin () |
| const_iterator | begin () const |
| iterator | end () |
| const_iterator | end () const |
| reverse_iterator | rbegin () |
| const_reverse_iterator | rbegin () const |
| reverse_iterator | rend () |
| const_reverse_iterator | rend () const |
| reference | operator[] (size_type i) |
| const_reference | operator[] (size_type i) const |
| reference | at (size_type i) |
| const_reference | at (size_type i) const |
| reference | front () |
| const_reference | front () const |
| reference | back () |
| const_reference | back () const |
| void | resize (const size_t nElements) |
| This method has no effects in this class, but raises an exception if the expected size does not match. More... | |
| void | swap (CArray< T, N > &y) |
| const T * | data () const |
| T * | data () |
| template<typename T2 > | |
| CArray< T, N > & | operator= (const CArray< T2, N > &rhs) |
| void | assign (const T &value) |
| void | assign (const size_t n, const T &value) |
| template<typename I > | |
| void | assign (I b, const I &e) |
Static Public Member Functions | |
| static size_type | size () |
| static bool | empty () |
| static size_type | max_size () |
Public Attributes | |
| T | elems [N] |
Static Private Member Functions | |
| static void | rangecheck (size_type i) |
Member Typedef Documentation
◆ const_iterator
| typedef const T* mrpt::utils::CArray< T, N >::const_iterator |
◆ const_reference
| typedef const T& mrpt::utils::CArray< T, N >::const_reference |
◆ const_reverse_iterator
| typedef std::reverse_iterator<const_iterator> mrpt::utils::CArray< T, N >::const_reverse_iterator |
◆ difference_type
| typedef std::ptrdiff_t mrpt::utils::CArray< T, N >::difference_type |
◆ iterator
| typedef T* mrpt::utils::CArray< T, N >::iterator |
◆ reference
| typedef T& mrpt::utils::CArray< T, N >::reference |
◆ reverse_iterator
| typedef std::reverse_iterator<iterator> mrpt::utils::CArray< T, N >::reverse_iterator |
◆ size_type
| typedef std::size_t mrpt::utils::CArray< T, N >::size_type |
◆ value_type
| typedef T mrpt::utils::CArray< T, N >::value_type |
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
Member Function Documentation
◆ assign() [1/3]
|
inline |
Definition at line 148 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ assign() [2/3]
|
inline |
Definition at line 143 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ assign() [3/3]
|
inline |
Definition at line 157 of file CArray.h.
References mrpt::utils::CArray< T, N >::begin(), mrpt::math::distance(), and mrpt::utils::CArray< T, N >::end().
◆ at() [1/2]
|
inline |
Definition at line 103 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems, and mrpt::utils::CArray< T, N >::rangecheck().
◆ at() [2/2]
|
inline |
Definition at line 104 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems, and mrpt::utils::CArray< T, N >::rangecheck().
◆ back() [1/2]
|
inline |
Definition at line 109 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ back() [2/2]
|
inline |
Definition at line 110 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ begin() [1/2]
|
inline |
Definition at line 68 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
Referenced by mrpt::utils::CArray< T, N >::assign(), mrpt::utils::CArray< T, N >::operator=(), mrpt::utils::CArray< T, N >::rend(), mrpt::utils::CArray< T, 0 >::rend(), and mrpt::utils::CArray< T, N >::swap().
◆ begin() [2/2]
|
inline |
Definition at line 69 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ data() [1/2]
|
inline |
Definition at line 133 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ data() [2/2]
|
inline |
Definition at line 130 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ empty()
|
inlinestatic |
◆ end() [1/2]
|
inline |
Definition at line 70 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
Referenced by mrpt::utils::CArray< T, N >::assign(), mrpt::utils::CArray< T, N >::operator=(), mrpt::utils::CArray< T, N >::rbegin(), mrpt::utils::CArray< T, 0 >::rbegin(), and mrpt::utils::CArray< T, N >::swap().
◆ end() [2/2]
|
inline |
Definition at line 71 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ front() [1/2]
|
inline |
Definition at line 107 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ front() [2/2]
|
inline |
Definition at line 108 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ max_size()
|
inlinestatic |
◆ operator=()
|
inline |
Definition at line 137 of file CArray.h.
References mrpt::utils::CArray< T, N >::begin(), and mrpt::utils::CArray< T, N >::end().
◆ operator[]() [1/2]
|
inline |
Definition at line 99 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ operator[]() [2/2]
|
inline |
Definition at line 100 of file CArray.h.
References mrpt::utils::CArray< T, N >::elems.
◆ rangecheck()
|
inlinestaticprivate |
Definition at line 166 of file CArray.h.
References mrpt::utils::CArray< T, N >::size().
Referenced by mrpt::utils::CArray< T, N >::at().
◆ rbegin() [1/2]
|
inline |
Definition at line 89 of file CArray.h.
References mrpt::utils::CArray< T, N >::end().
◆ rbegin() [2/2]
|
inline |
Definition at line 90 of file CArray.h.
References mrpt::utils::CArray< T, N >::end().
◆ rend() [1/2]
|
inline |
Definition at line 93 of file CArray.h.
References mrpt::utils::CArray< T, N >::begin().
◆ rend() [2/2]
|
inline |
Definition at line 94 of file CArray.h.
References mrpt::utils::CArray< T, N >::begin().
◆ resize()
|
inline |
This method has no effects in this class, but raises an exception if the expected size does not match.
Definition at line 119 of file CArray.h.
References mrpt::format().
◆ size()
|
inlinestatic |
Definition at line 113 of file CArray.h.
Referenced by mrpt::utils::CArray< T, N >::rangecheck().
◆ swap()
|
inline |
Definition at line 125 of file CArray.h.
References mrpt::utils::CArray< T, N >::begin(), and mrpt::utils::CArray< T, N >::end().
Member Data Documentation
◆ elems
| T mrpt::utils::CArray< T, N >::elems[N] |
Definition at line 55 of file CArray.h.
Referenced by mrpt::utils::CArray< T, N >::assign(), mrpt::utils::CArray< T, N >::at(), mrpt::utils::CArray< T, N >::back(), mrpt::utils::CArray< T, N >::begin(), mrpt::utils::CArray< T, N >::data(), mrpt::utils::CArray< T, N >::end(), mrpt::utils::CArray< T, N >::front(), and mrpt::utils::CArray< T, N >::operator[]().