cml::external_1D< Element, Size > Class Template Reference
Fixed-size external 1D array. More...
#include <external_1D.h>
Public Types | |
| enum | { array_size = Size } |
| The length as an enumerated value. More... | |
| typedef value_type | array_impl [Size] |
| typedef const Element * | const_pointer |
| typedef const Element & | const_reference |
| typedef oned_tag | dimension_tag |
| typedef external< Size,-1 > | generator_type |
| typedef external_memory_tag | memory_tag |
| typedef Element * | pointer |
| typedef Element & | reference |
| typedef not_resizable_tag | resizing_tag |
| typedef fixed_size_tag | size_tag |
| typedef Element | value_type |
Public Member Functions | |
| CML_STATIC_REQUIRE (Size > 0) | |
| const_pointer | data () const |
| Return access to the data as a raw pointer. | |
| pointer | data () |
| Return access to the data as a raw pointer. | |
| external_1D (pointer const ptr) | |
| const_reference | operator[] (size_t i) const |
| Const access to the data as a C array. | |
| reference | operator[] (size_t i) |
| Access to the data as a C array. | |
| size_t | size () const |
| Return the number of elements in the array. | |
Protected Attributes | |
| pointer const | m_data |
Private Member Functions | |
| external_1D () | |
Detailed Description
template<typename Element, int Size = -1>
class cml::external_1D< Element, Size >
Fixed-size external 1D array.
Both the memory and the size are fixed at compile time, and cannot be changed.
Definition at line 34 of file external_1D.h.
Member Typedef Documentation
| typedef value_type cml::external_1D< Element, Size >::array_impl[Size] |
Definition at line 52 of file external_1D.h.
| typedef const Element* cml::external_1D< Element, Size >::const_pointer |
Definition at line 49 of file external_1D.h.
| typedef const Element& cml::external_1D< Element, Size >::const_reference |
Reimplemented in cml::vector< Element, external< Size > >, and cml::vector< Element, external<> >.
Definition at line 48 of file external_1D.h.
| typedef oned_tag cml::external_1D< Element, Size >::dimension_tag |
Definition at line 64 of file external_1D.h.
| typedef external<Size,-1> cml::external_1D< Element, Size >::generator_type |
Reimplemented in cml::vector< Element, external< Size > >, and cml::vector< Element, external<> >.
Definition at line 42 of file external_1D.h.
| typedef external_memory_tag cml::external_1D< Element, Size >::memory_tag |
Reimplemented in cml::vector< Element, external< Size > >, and cml::vector< Element, external<> >.
Definition at line 55 of file external_1D.h.
| typedef Element* cml::external_1D< Element, Size >::pointer |
Definition at line 46 of file external_1D.h.
| typedef Element& cml::external_1D< Element, Size >::reference |
Reimplemented in cml::vector< Element, external< Size > >, and cml::vector< Element, external<> >.
Definition at line 47 of file external_1D.h.
| typedef not_resizable_tag cml::external_1D< Element, Size >::resizing_tag |
| typedef fixed_size_tag cml::external_1D< Element, Size >::size_tag |
Reimplemented in cml::vector< Element, external< Size > >, and cml::vector< Element, external<> >.
Definition at line 58 of file external_1D.h.
| typedef Element cml::external_1D< Element, Size >::value_type |
Reimplemented in cml::vector< Element, external< Size > >, and cml::vector< Element, external<> >.
Definition at line 45 of file external_1D.h.
Member Enumeration Documentation
| anonymous enum |
Constructor & Destructor Documentation
| cml::external_1D< Element, Size >::external_1D | ( | pointer const | ptr | ) | [inline] |
Definition at line 75 of file external_1D.h.
| cml::external_1D< Element, Size >::external_1D | ( | ) | [private] |
Member Function Documentation
| cml::external_1D< Element, Size >::CML_STATIC_REQUIRE | ( | Size | , | |
| 0 | ||||
| ) |
| const_pointer cml::external_1D< Element, Size >::data | ( | ) | const [inline] |
| pointer cml::external_1D< Element, Size >::data | ( | ) | [inline] |
| const_reference cml::external_1D< Element, Size >::operator[] | ( | size_t | i | ) | const [inline] |
Const access to the data as a C array.
- Parameters:
-
i a size_t index into the array.
- Returns:
- a const reference to the array value at i.
- Note:
- This function does not range-check the argument.
Definition at line 100 of file external_1D.h.
| reference cml::external_1D< Element, Size >::operator[] | ( | size_t | i | ) | [inline] |
Access to the data as a C array.
- Parameters:
-
i a size_t index into the array.
- Returns:
- a mutable reference to the array value at i.
- Note:
- This function does not range-check the argument.
Definition at line 91 of file external_1D.h.
| size_t cml::external_1D< Element, Size >::size | ( | ) | const [inline] |
Member Data Documentation
pointer const cml::external_1D< Element, Size >::m_data [protected] |
Definition at line 111 of file external_1D.h.
Referenced by cml::external_1D< Element,-1 >::data(), cml::external_1D< Element, Size >::data(), cml::external_1D< Element,-1 >::operator[](), and cml::external_1D< Element, Size >::operator[]().
The documentation for this class was generated from the following file:
- cml/core/external_1D.h
