1D Array of constant elements with garbage collection and bounds checking. More...

#include <SharedArray.hpp>

Inheritance diagram for Nektar::Array< OneD, const DataType >:

Public Types
typedef DataType *	ArrayType

typedef const DataType &	const_reference

typedef DataType &	reference

typedef const DataType *	const_iterator

typedef DataType *	iterator

typedef DataType	element

typedef size_t	size_type

Public Member Functions
	Array ()
	Creates an empty array. More...

	Array (size_type dim1Size)
	Creates an array of size dim1Size. More...

	Array (size_type dim1Size, const DataType &initValue)
	Creates a 1D array with each element initialized to an initial value. More...

	Array (size_type dim1Size, const DataType *data)
	Creates a 1D array a copies data into it. More...

	Array (size_type dim1Size, const Array< OneD, const DataType > &rhs)
	Creates a 1D array that references rhs. More...

	Array (const Array< OneD, const DataType > &rhs)
	Creates a reference to rhs. More...

	~Array ()

Array< OneD, const DataType > &	operator= (const Array< OneD, const DataType > &rhs)
	Creates a reference to rhs. More...

const_iterator	begin () const

const_iterator	end () const

const_reference	operator[] (size_type i) const

const element *	get () const
	Returns a c-style pointer to the underlying array. More...

const element *	data () const
	Returns a c-style pointer to the underlying array. More...

size_type	num_dimensions () const
	Returns 1. More...

size_type	size () const
	Returns the array's size. More...

size_type	num_elements () const
	Returns the array's size. Deprecated. More...

size_type	capacity () const
	Returns the array's capacity. More...

size_type	GetOffset () const
	Returns the array's offset. More...

size_type	GetCount () const
	Returns the array's reference counter. More...

bool	Overlaps (const Array< OneD, const DataType > &rhs) const
	Returns true is this array and rhs overlap. More...

Protected Attributes
size_type	m_size

size_type	m_capacity

DataType *	m_data

size_type *	m_count

size_type	m_offset

Private Member Functions
void	CreateStorage (size_type size)

Static Private Member Functions
template<typename T >
static Array< OneD, T >	CreateWithOffset (const Array< OneD, T > &rhs, size_type offset)

Friends
template<typename T >
Array< OneD, T >	operator+ (const Array< OneD, T > &lhs, typename Array< OneD, T >::size_type offset)
	Creates an array with a specified offset. More...

template<typename T >
Array< OneD, T >	operator+ (typename Array< OneD, T >::size_type offset, const Array< OneD, T > &rhs)

Detailed Description

template<typename DataType>
class Nektar::Array< OneD, const DataType >

1D Array of constant elements with garbage collection and bounds checking.

Definition at line 55 of file SharedArray.hpp.

Member Typedef Documentation

◆ ArrayType

template<typename DataType >

typedef DataType* Nektar::Array< OneD, const DataType >::ArrayType

Definition at line 65 of file SharedArray.hpp.

◆ const_iterator

template<typename DataType >

typedef const DataType* Nektar::Array< OneD, const DataType >::const_iterator

Definition at line 70 of file SharedArray.hpp.

◆ const_reference

template<typename DataType >

typedef const DataType& Nektar::Array< OneD, const DataType >::const_reference

Definition at line 67 of file SharedArray.hpp.

◆ element

template<typename DataType >

typedef DataType Nektar::Array< OneD, const DataType >::element

Definition at line 73 of file SharedArray.hpp.

◆ iterator

template<typename DataType >

typedef DataType* Nektar::Array< OneD, const DataType >::iterator

Definition at line 71 of file SharedArray.hpp.

◆ reference

template<typename DataType >

typedef DataType& Nektar::Array< OneD, const DataType >::reference

Definition at line 68 of file SharedArray.hpp.

◆ size_type

template<typename DataType >

typedef size_t Nektar::Array< OneD, const DataType >::size_type

Definition at line 74 of file SharedArray.hpp.

Constructor & Destructor Documentation

◆ Array() [1/6]

template<typename DataType >

Nektar::Array< OneD, const DataType >::Array ( )

inline

Creates an empty array.

Definition at line 78 of file SharedArray.hpp.

        :
#ifdef WITH_PYTHON
          m_pythonInfo(nullptr),
#endif
          m_size(0), m_capacity(0), m_data(nullptr), m_count(nullptr),
          m_offset(0)
    {
        CreateStorage(m_capacity);
    }

References Nektar::CreateStorage().

◆ Array() [2/6]

template<typename DataType >

Nektar::Array< OneD, const DataType >::Array ( size_type dim1Size )

inlineexplicit

Creates an array of size dim1Size.

If DataType is a fundamental type (double, int, etc.), then the allocated array is uninitialized. If it is any other type, each element is initialized with DataType's default constructor.

Definition at line 94 of file SharedArray.hpp.

        :
#ifdef WITH_PYTHON
          m_pythonInfo(nullptr),
#endif
          m_size(dim1Size), m_capacity(dim1Size), m_data(nullptr),
          m_count(nullptr), m_offset(0)
    {
        CreateStorage(m_capacity);
        ArrayInitializationPolicy<DataType>::Initialize(m_data, m_capacity);
    }

References Nektar::CreateStorage().

◆ Array() [3/6]

template<typename DataType >

Nektar::Array< OneD, const DataType >::Array	(	size_type	dim1Size,
		const DataType &	initValue
	)

inline

Creates a 1D array with each element initialized to an initial value.

Parameters

dim1Size	The array's size.
initValue	Each element's initial value.

If DataType is a fundamental type (double, int, etc.), then the initial value is copied directly into each element. Otherwise, the DataType's copy constructor is used to initialize each element.

Definition at line 115 of file SharedArray.hpp.

        :
#ifdef WITH_PYTHON
          m_pythonInfo(nullptr),
#endif
          m_size(dim1Size), m_capacity(dim1Size), m_data(nullptr),
          m_count(nullptr), m_offset(0)
    {
        CreateStorage(m_capacity);
        ArrayInitializationPolicy<DataType>::Initialize(m_data, m_capacity,
                                                        initValue);
    }

References Nektar::CreateStorage().

◆ Array() [4/6]

template<typename DataType >

Nektar::Array< OneD, const DataType >::Array	(	size_type	dim1Size,
		const DataType *	data
	)

inline

Creates a 1D array a copies data into it.

Parameters

dim1Size	the array's size.
data	The data to copy.

If DataType is a fundamental type (double, int, etc.), then data is copied directly into the underlying storage. Otherwise, the DataType's copy constructor is used to copy each element.

Definition at line 135 of file SharedArray.hpp.

        :
#ifdef WITH_PYTHON
          m_pythonInfo(nullptr),
#endif
          m_size(dim1Size), m_capacity(dim1Size), m_data(nullptr),
          m_count(nullptr), m_offset(0)
    {
        CreateStorage(m_capacity);
        ArrayInitializationPolicy<DataType>::Initialize(m_data, m_capacity,
                                                        data);
    }

References Nektar::CreateStorage().

◆ Array() [5/6]

template<typename DataType >

Nektar::Array< OneD, const DataType >::Array	(	size_type	dim1Size,
		const Array< OneD, const DataType > &	rhs
	)

inline

Creates a 1D array that references rhs.

Parameters

dim1Size	The size of the array. This is useful when you want this array to reference a subset of the elements in rhs.
rhs	Array to reference. This constructor creates an array that references rhs. Any changes to rhs will be reflected in this array. The memory for the array will only be deallocated when both rhs and this array have gone out of scope.

Definition at line 157 of file SharedArray.hpp.

        :
#ifdef WITH_PYTHON
          m_pythonInfo(rhs.m_pythonInfo),
#endif
          m_size(dim1Size), m_capacity(rhs.m_capacity), m_data(rhs.m_data),
          m_count(rhs.m_count), m_offset(rhs.m_offset)
    {
        *m_count += 1;
        ASSERTL0(m_size <= rhs.size(), "Requested size is \
                    larger than input array size.");
    }

References ASSERTL0, and size().

◆ Array() [6/6]

template<typename DataType >

Nektar::Array< OneD, const DataType >::Array ( const Array< OneD, const DataType > & rhs )

inline

Creates a reference to rhs.

Definition at line 192 of file SharedArray.hpp.

        :
#ifdef WITH_PYTHON
          m_pythonInfo(rhs.m_pythonInfo),
#endif
          m_size(rhs.m_size), m_capacity(rhs.m_capacity), m_data(rhs.m_data),
          m_count(rhs.m_count), m_offset(rhs.m_offset)
    {
        *m_count += 1;
    }

◆ ~Array()

template<typename DataType >

Nektar::Array< OneD, const DataType >::~Array ( )

inline

Definition at line 209 of file SharedArray.hpp.

    {
        if (m_count == nullptr)
        {
            return;
        }
 
        *m_count -= 1;
        if (*m_count == 0)
        {
#ifdef WITH_PYTHON
            if (*m_pythonInfo == nullptr)
            {
                ArrayDestructionPolicy<DataType>::Destroy(m_data, m_capacity);
                MemoryManager<DataType>::RawDeallocate(m_data, m_capacity);
            }
            else
            {
                (*m_pythonInfo)->m_callback((*m_pythonInfo)->m_pyObject);
                delete *m_pythonInfo;
            }
 
            delete m_pythonInfo;
            m_pythonInfo = nullptr;
#else
 
            ArrayDestructionPolicy<DataType>::Destroy(m_data, m_capacity);
            MemoryManager<DataType>::RawDeallocate(m_data, m_capacity);
 
#endif
 
            delete m_count; // Clean up the memory used for the reference count.
            m_count = nullptr;
        }
    }

References Nektar::MemoryManager< DataType >::RawDeallocate().

Member Function Documentation

◆ begin()

template<typename DataType >

const_iterator Nektar::Array< OneD, const DataType >::begin ( ) const

inline

Definition at line 292 of file SharedArray.hpp.

    {
        return m_data + m_offset;
    }

◆ capacity()

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::capacity ( ) const

inline

Returns the array's capacity.

Definition at line 345 of file SharedArray.hpp.

    {
        return m_capacity;
    }

◆ CreateStorage()

template<typename DataType >

void Nektar::Array< OneD, const DataType >::CreateStorage ( size_type size )

inlineprivate

Definition at line 424 of file SharedArray.hpp.

    {
        DataType *storage = MemoryManager<DataType>::RawAllocate(size);
        m_data            = storage;
 
        // Allocate an integer to hold the reference count.  Note 1, all arrays
        // that share this array's data (ie, point to m_data) will also share
        // the m_count data.  Note 2, previously m_count pointed to "(unsigned
        // int*)storage".
        m_count  = new size_type();
        *m_count = 1;
#ifdef WITH_PYTHON
        m_pythonInfo  = new PythonInfo *();
        *m_pythonInfo = nullptr;
#endif
    }

References Nektar::MemoryManager< DataType >::RawAllocate().

◆ CreateWithOffset()

template<typename DataType >

template<typename T >

static Array< OneD, T > Nektar::Array< OneD, const DataType >::CreateWithOffset	(	const Array< OneD, T > &	rhs,
		size_type	offset
	)

inlinestaticprivate

Definition at line 442 of file SharedArray.hpp.

    {
        Array<OneD, T> result(rhs);
        result.m_offset += offset;
        result.m_size = rhs.m_size - offset;
        return result;
    }

◆ data()

template<typename DataType >

const element * Nektar::Array< OneD, const DataType >::data ( ) const

inline

Returns a c-style pointer to the underlying array.

Definition at line 317 of file SharedArray.hpp.

    {
        return m_data + m_offset;
    }

◆ end()

template<typename DataType >

const_iterator Nektar::Array< OneD, const DataType >::end ( ) const

inline

Definition at line 296 of file SharedArray.hpp.

    {
        return m_data + m_offset + m_size;
    }

◆ get()

template<typename DataType >

const element * Nektar::Array< OneD, const DataType >::get ( ) const

inline

Returns a c-style pointer to the underlying array.

Definition at line 311 of file SharedArray.hpp.

    {
        return m_data + m_offset;
    }

Referenced by Overlaps().

◆ GetCount()

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::GetCount ( ) const

inline

Returns the array's reference counter.

Definition at line 357 of file SharedArray.hpp.

    {
        return *m_count;
    }

◆ GetOffset()

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::GetOffset ( ) const

inline

Returns the array's offset.

Definition at line 351 of file SharedArray.hpp.

    {
        return m_offset;
    }

◆ num_dimensions()

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::num_dimensions ( ) const

inline

Returns 1.

Definition at line 323 of file SharedArray.hpp.

    {
        return 1;
    }

◆ num_elements()

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::num_elements ( ) const

inline

Returns the array's size. Deprecated.

Definition at line 336 of file SharedArray.hpp.

    {
        WARNINGL1(false, "member function num_elements() is deprecated, "
                         "use size() instead.");
        return m_size;
    }

References WARNINGL1.

◆ operator=()

template<typename DataType >

Array< OneD, const DataType > & Nektar::Array< OneD, const DataType >::operator= ( const Array< OneD, const DataType > & rhs )

inline

Creates a reference to rhs.

Definition at line 246 of file SharedArray.hpp.

    {
        *m_count -= 1;
        if (*m_count == 0)
        {
#ifdef WITH_PYTHON
            if (*m_pythonInfo == nullptr)
            {
                ArrayDestructionPolicy<DataType>::Destroy(m_data, m_capacity);
                MemoryManager<DataType>::RawDeallocate(m_data, m_capacity);
            }
            else if ((*rhs.m_pythonInfo) != nullptr &&
                     (*m_pythonInfo)->m_pyObject !=
                         (*rhs.m_pythonInfo)->m_pyObject)
            {
                (*m_pythonInfo)->m_callback((*m_pythonInfo)->m_pyObject);
                delete *m_pythonInfo;
            }
 
            delete m_pythonInfo;
            m_pythonInfo = nullptr;
#else
 
            ArrayDestructionPolicy<DataType>::Destroy(m_data, m_capacity);
            MemoryManager<DataType>::RawDeallocate(m_data, m_capacity);
#endif
            delete m_count; // Clean up the memory used for the reference count.
            m_count = nullptr;
        }
 
        m_data     = rhs.m_data;
        m_capacity = rhs.m_capacity;
        m_count    = rhs.m_count;
        *m_count += 1;
        m_offset = rhs.m_offset;
        m_size   = rhs.m_size;
#ifdef WITH_PYTHON
        m_pythonInfo = rhs.m_pythonInfo;
#endif
        return *this;
    }

References m_capacity, m_count, m_data, m_offset, m_size, and Nektar::MemoryManager< DataType >::RawDeallocate().

◆ operator[]()

template<typename DataType >

const_reference Nektar::Array< OneD, const DataType >::operator[] ( size_type i ) const

inline

Definition at line 301 of file SharedArray.hpp.

    {
        ASSERTL1(i < m_size,
                 std::string("Element ") + std::to_string(i) +
                     std::string(" requested in an array of size ") +
                     std::to_string(m_size));
        return *(m_data + i + m_offset);
    }

References ASSERTL1.

◆ Overlaps()

template<typename DataType >

bool Nektar::Array< OneD, const DataType >::Overlaps ( const Array< OneD, const DataType > & rhs ) const

inline

Returns true is this array and rhs overlap.

Definition at line 363 of file SharedArray.hpp.

    {
        const element *start = get();
        const element *end   = start + m_size;
 
        const element *rhs_start = rhs.get();
        const element *rhs_end   = rhs_start + rhs.size();
 
        return (rhs_start >= start && rhs_start <= end) ||
               (rhs_end >= start && rhs_end <= end);
    }

References get(), and size().

◆ size()

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::size ( ) const

inline

Returns the array's size.

Definition at line 329 of file SharedArray.hpp.

    {
        return m_size;
    }

Referenced by Nektar::SolverUtils::Advection::AddTraceJacToMat(), Array(), Nektar::StorageSmvBsr< T >::const_iterator::const_iterator(), Nektar::CopyArray(), Nektar::CopyArrayN(), Nektar::FullMatrixFuncs::EigenSolve(), Nektar::StorageSmvBsr< T >::const_iterator::forward(), Nektar::CFSImplicit::MultiplyElmtInvMassPlusSource(), Nektar::LibUtilities::NodalTriElec::NodalPointReorder2d(), Nektar::LibUtilities::NodalTriFekete::NodalPointReorder2d(), Nektar::NekVector< NekDouble >::operator/=(), Overlaps(), and Nektar::NekMatrix< DataType, StandardMatrixTag >::PerformCopyConstruction().

Friends And Related Function Documentation

◆ operator+ [1/2]

template<typename DataType >

template<typename T >

Array< OneD, T > operator+	(	const Array< OneD, T > &	lhs,
		typename Array< OneD, T >::size_type	offset
	)

friend

Creates an array with a specified offset.

The return value will reference the same array as lhs, but with an offset.

For example, in the following:

Array<OneD, const double> result = anArray + 10;

Nektar::Array

Definition: SharedArray.hpp:51

result[0] == anArray[10];

◆ operator+ [2/2]

template<typename DataType >

template<typename T >

Array< OneD, T > operator+	(	typename Array< OneD, T >::size_type	offset,
		const Array< OneD, T > &	rhs
	)

friend

Member Data Documentation

◆ m_capacity

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::m_capacity

protected

Definition at line 413 of file SharedArray.hpp.

Referenced by operator=().

◆ m_count

template<typename DataType >

size_type* Nektar::Array< OneD, const DataType >::m_count

protected

Definition at line 419 of file SharedArray.hpp.

Referenced by operator=().

◆ m_data

template<typename DataType >

DataType* Nektar::Array< OneD, const DataType >::m_data

protected

Definition at line 414 of file SharedArray.hpp.

Referenced by operator=().

◆ m_offset

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::m_offset

protected

Definition at line 421 of file SharedArray.hpp.

Referenced by Nektar::Array< OneD, DataType >::CreateWithOffset(), and operator=().

◆ m_size

template<typename DataType >

size_type Nektar::Array< OneD, const DataType >::m_size

protected

Definition at line 412 of file SharedArray.hpp.

Referenced by Nektar::Array< OneD, DataType >::CreateWithOffset(), and operator=().

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ ArrayType

◆ const_iterator

◆ const_reference

◆ element

◆ iterator

◆ reference

◆ size_type

Constructor & Destructor Documentation

◆ Array() [1/6]

◆ Array() [2/6]

◆ Array() [3/6]

◆ Array() [4/6]

◆ Array() [5/6]

◆ Array() [6/6]

◆ ~Array()

Member Function Documentation

◆ begin()

◆ capacity()

◆ CreateStorage()

◆ CreateWithOffset()

◆ data()

◆ end()

◆ get()

◆ GetCount()

◆ GetOffset()

◆ num_dimensions()

◆ num_elements()

◆ operator=()

◆ operator[]()

◆ Overlaps()

◆ size()

Friends And Related Function Documentation

◆ operator+ [1/2]

◆ operator+ [2/2]

Member Data Documentation

◆ m_capacity

◆ m_count

◆ m_data

◆ m_offset

◆ m_size