The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays. More...

#include <NCollection_Array1.hxx>

Inheritance diagram for NCollection_Array1< TheItemType >:

[legend]

Public Types
typedef NCollection_Allocator< TheItemType >	allocator_type
	Memory allocation.

using	value_type = TheItemType

using	size_type = size_t

using	difference_type = size_t

using	pointer = TheItemType*

using	const_pointer = const TheItemType*

using	reference = TheItemType&

using	const_reference = const TheItemType&

using	iterator

using	const_iterator

using	Iterator = NCollection_Iterator<NCollection_Array1<TheItemType>>

Public Member Functions
const_iterator	begin () const noexcept

iterator	begin () noexcept

const_iterator	cbegin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

const_iterator	cend () const noexcept

	NCollection_Array1 () noexcept

	NCollection_Array1 (const int theLower, const int theUpper)

	NCollection_Array1 (const_reference theBegin, const int theLower, const int theUpper, const bool theUseBuffer=true)

	NCollection_Array1 (const size_t theSize)
	Zero-based constructor: allocates theSize elements with lower bound 0. Use At()/ChangeAt() or STL iterators for optimal access (no offset subtraction).

	NCollection_Array1 (pointer theBegin, const size_t theSize)
	Zero-based buffer-reuse constructor: wraps an existing C array of theSize elements. The array does NOT own the buffer and will NOT free it on destruction. Use At()/ChangeAt() or STL iterators for optimal access (no offset subtraction).

	NCollection_Array1 (const NCollection_Array1 &theOther)
	Copy constructor.

	NCollection_Array1 (NCollection_Array1 &&theOther) noexcept
	Move constructor.

virtual	~NCollection_Array1 ()

void	Init (const_reference theValue)
	Initialise the items with theValue.

size_t	Size () const noexcept
	Size query.

int	Length () const noexcept
	Length query (legacy int-returning API).

bool	IsEmpty () const noexcept
	Return TRUE if array has zero length.

int	Lower () const noexcept
	Lower bound.

int	Upper () const noexcept
	Upper bound.

NCollection_Array1 &	Assign (const NCollection_Array1 &theOther)
	Replaces this array by a copy of theOther array. Bounds and length are copied from theOther. When this array wraps an external (non-owned) buffer:

NCollection_Array1 &	CopyValues (const NCollection_Array1 &theOther)
	Copies values from theOther array without changing this array bounds. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.

NCollection_Array1 &	Move (NCollection_Array1 &&theOther) noexcept
	Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction.

NCollection_Array1 &	Move (NCollection_Array1 &theOther) noexcept

NCollection_Array1 &	operator= (const NCollection_Array1 &theOther)
	Assignment operator;.

NCollection_Array1 &	operator= (NCollection_Array1 &&theOther) noexcept
	Move assignment operator;.

const_reference	First () const noexcept

reference	ChangeFirst () noexcept

const_reference	Last () const noexcept

reference	ChangeLast () noexcept

const_reference	Value (const int theIndex) const
	Constant value access.

const_reference	operator() (const int theIndex) const
	operator() - alias to Value

const_reference	operator[] (const int theIndex) const
	operator[] - alias to Value

reference	ChangeValue (const int theIndex)
	Variable value access.

reference	operator() (const int theIndex)
	operator() - alias to ChangeValue

reference	operator[] (const int theIndex)
	operator[] - alias to ChangeValue

const_reference	At (const size_t theIndex) const
	0-based checked access independent of Lower()/Upper().

reference	ChangeAt (const size_t theIndex)
	0-based checked mutable access independent of Lower()/Upper().

void	SetValue (const int theIndex, const value_type &theItem)
	Set value.

void	SetValue (const int theIndex, value_type &&theItem)
	Set value.

template<typename... Args>
reference	EmplaceValue (const int theIndex, Args &&... theArgs)
	Emplace value at the specified index, constructing it in-place.

void	UpdateLowerBound (const int theLower) noexcept
	Changes the lowest bound. Do not move data.

void	UpdateUpperBound (const int theUpper) noexcept
	Changes the upper bound. Do not move data.

void	Resize (const int theLower, const int theUpper, const bool theToCopyData)
	Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.

void	Resize (const size_t theSize, const bool theToCopyData)
	Resizes the array to theSize elements, keeping the lower bound unchanged.

bool	IsDeletable () const noexcept

Data Fields
friend	iterator

friend	const_iterator

Protected Member Functions
void	resizeImpl (const size_t theNewSize, const int theNewLower, const bool theToCopyData)
	Core resize implementation used by all public Resize() overloads.

const_reference	at (const size_t theIndex) const

reference	at (const size_t theIndex)

template<typename U = TheItemType>
std::enable_if< std::is_trivially_default_constructible< U >::value, void >::type	construct (const size_t, const size_t)

template<typename U = TheItemType>
std::enable_if<!std::is_trivially_default_constructible< U >::value, void >::type	construct (const size_t theFrom, const size_t theTo)

template<typename U = TheItemType>
std::enable_if< std::is_trivially_destructible< U >::value, void >::type	destroy (pointer, const size_t, const size_t)

template<typename U = TheItemType>
std::enable_if<!std::is_trivially_destructible< U >::value, void >::type	destroy (pointer theWhat, const size_t theFrom, const size_t theTo)

void	assign (const const_pointer theFrom, const size_t theSize, const int theLower)

template<typename U = TheItemType>
std::enable_if< std::is_trivially_copyable< U >::value, void >::type	copyAssign (pointer theTarget, const_pointer theFrom, const size_t theCount)

template<typename U = TheItemType>
std::enable_if<!std::is_trivially_copyable< U >::value, void >::type	copyAssign (pointer theTarget, const_pointer theFrom, const size_t theCount)

void	copyConstruct (const pointer theFrom, const size_t theCount)

template<typename U = TheItemType>
std::enable_if< std::is_trivially_copyable< U >::value, void >::type	copyConstruct (pointer theTarget, const_pointer theFrom, const size_t theCount)

template<typename U = TheItemType>
std::enable_if<!std::is_trivially_copyable< U >::value, void >::type	copyConstruct (pointer theTarget, const_pointer theFrom, const size_t theCount)

Protected Attributes
int	myLowerBound

size_t	mySize

pointer	myPointer = nullptr

bool	myIsOwner = false

allocator_type	myAllocator

Detailed Description

template<class TheItemType>
class NCollection_Array1< TheItemType >

The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.

Examples:

Item tab[100]; // an example with a C array
NCollection_Array1<Item> ttab (tab[0], 1, 100);
 
NCollection_Array1<Item> tttab (ttab(10), 10, 20); // a slice of ttab

If you want to reindex an array from 1 to Length do:

NCollection_Array1<Item> tab1 (tab (tab.Lower()), 1, tab.Length());

Warning: Programs client of such a class must be independent of the range of the first element. Then, a C++ for loop must be written like this

for (i = A.Lower(); i <= A.Upper(); i++)

Zero-based (size_t) construction mode: Use NCollection_Array1(size_t theSize) or NCollection_Array1(pointer, size_t) to create a zero-based array (Lower()==0). In this mode At()/ChangeAt() and STL iterators are the preferred access path - they address elements directly without any offset subtraction. Buffer-reuse variants do NOT own the memory and will not free it on destruction.

int aBuffer[100];
NCollection_Array1<int> aZero(100);      // allocates, lower=0
NCollection_Array1<int> aWrap(aBuffer, 100); // wraps aBuffer, lower=0, not owner
for (size_t i = 0; i < aWrap.Size(); ++i)
  aWrap.At(i) = static_cast<int>(i);

theIndex	index at which to emplace the value
theArgs	arguments forwarded to TheItemType constructor

theLower	new lower bound of array
theUpper	new upper bound of array
theToCopyData	flag to copy existing data into new array

theSize	new number of elements
theToCopyData	flag to copy existing data into new array

theNewSize	new number of elements
theNewLower	new lower bound value to store
theToCopyData	whether to preserve existing elements

Public Types

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ difference_type

◆ iterator

◆ Iterator

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ NCollection_Array1() [1/7]

◆ NCollection_Array1() [2/7]

◆ NCollection_Array1() [3/7]

◆ NCollection_Array1() [4/7]

◆ NCollection_Array1() [5/7]

◆ NCollection_Array1() [6/7]

◆ NCollection_Array1() [7/7]

◆ ~NCollection_Array1()

Member Function Documentation

◆ assign()

◆ Assign()

◆ at() [1/2]

◆ At()

◆ at() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ ChangeAt()

◆ ChangeFirst()

◆ ChangeLast()

◆ ChangeValue()

◆ construct() [1/2]

◆ construct() [2/2]

◆ copyAssign() [1/2]

◆ copyAssign() [2/2]

◆ copyConstruct() [1/3]

◆ copyConstruct() [2/3]

◆ copyConstruct() [3/3]

◆ CopyValues()

◆ destroy() [1/2]

◆ destroy() [2/2]

◆ EmplaceValue()

◆ end() [1/2]

◆ end() [2/2]

◆ First()

◆ Init()

◆ IsDeletable()

◆ IsEmpty()

◆ Last()

◆ Length()

◆ Lower()

◆ Move() [1/2]

◆ Move() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Resize() [1/2]

◆ Resize() [2/2]

◆ resizeImpl()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ Size()

◆ UpdateLowerBound()

◆ UpdateUpperBound()

◆ Upper()

◆ Value()

Field Documentation