pxl::NDArray< T > Class Template Reference

NDArray is a class that can be used in both host and device code. NDArray is automatically divided into multiple NDArray slices for each task. More...

Public Types
using	ShapeArray = std::array< std::int64_t, MAX_DIMS >
using	StridesArray = std::array< std::int64_t, MAX_DIMS >

Public Member Functions
	NDArray ()=default
template<typename U >
	NDArray (T *data, std::initializer_list< U > shape)
	NDArray (T *data, const ShapeArray &shape)
	NDArray (void *data, const ShapeArray &shape, std::int64_t elemSize)
	~NDArray ()=default
T *	data ()
const T *	data () const
void	setData (void *data)
const ShapeArray &	shape () const
const StridesArray &	strides () const
std::int64_t	dims () const
std::int64_t	elemSize () const
std::int64_t	size () const
std::int64_t	numElements () const
template<typename... Idxs>
T &	operator() (Idxs... idxs)
template<typename... Idxs>
const T &	operator() (Idxs... idxs) const
NDArray< T >	operator[] (std::int64_t idx)
NDArray< const T >	operator[] (std::int64_t idx) const
template<typename U = T>
	operator typename std::enable_if_t< std::is_same_v< U, std::remove_const_t< T >>, T & > ()
	operator const T & () const
T &	scalar ()
const T &	scalar () const
template<typename... Idxs>
T &	at (Idxs... idxs)
template<typename... Idxs>
const T &	at (Idxs... idxs) const

Static Public Attributes
static constexpr std::int64_t	MAX_DIMS = 10

Detailed Description

template<typename T>
class pxl::NDArray< T >

NDArray is a class that can be used in both host and device code. NDArray is automatically divided into multiple NDArray slices for each task.

Definition at line 24 of file ndarray.hpp.

Member Typedef Documentation

ShapeArray

template<typename T >

using pxl::NDArray< T >::ShapeArray = std::array<std::int64_t, MAX_DIMS>

Definition at line 28 of file ndarray.hpp.

StridesArray

template<typename T >

using pxl::NDArray< T >::StridesArray = std::array<std::int64_t, MAX_DIMS>

Definition at line 29 of file ndarray.hpp.

Constructor & Destructor Documentation

NDArray() [1/4]

template<typename T >

pxl::NDArray< T >::NDArray ( )

default

NDArray() [2/4]

template<typename T >

template<typename U >

pxl::NDArray< T >::NDArray ( T *  data, std::initializer_list< U >  shape  )

inline

Definition at line 33 of file ndarray.hpp.

        : data_(const_cast<void*>(static_cast<const void*>(data))),
          dims_(static_cast<std::int64_t>(shape.size())),
          elemSize_(sizeof(T))
    {
        std::fill(shape_.begin(), shape_.end(), 0);
        std::fill(strides_.begin(), strides_.end(), 0);
        for (size_t i = 0; i < shape.size(); ++i)
        {
            shape_[i] = static_cast<std::int64_t>(*(shape.begin() + i));
        }
        calculateSizeAndStrides();
    }

NDArray() [3/4]

template<typename T >

pxl::NDArray< T >::NDArray ( T *  data, const ShapeArray &  shape  )

inline

Definition at line 46 of file ndarray.hpp.

        : data_(const_cast<void*>(reinterpret_cast<const void*>(data))),
          dims_(0),
          elemSize_(sizeof(T))
    {
        std::fill(shape_.begin(), shape_.end(), 0);
        std::fill(strides_.begin(), strides_.end(), 0);
        for (size_t i = 0; i < MAX_DIMS; ++i)
        {
            if (shape[i] != 0)
            {
                shape_[i] = shape[i];
                dims_++;
            }
        }
        calculateSizeAndStrides();
    }

NDArray() [4/4]

template<typename T >

pxl::NDArray< T >::NDArray ( void *  data, const ShapeArray &  shape, std::int64_t  elemSize  )

inline

Definition at line 64 of file ndarray.hpp.

        : data_(data),
          dims_(0),
          elemSize_(elemSize)
    {
        std::fill(shape_.begin(), shape_.end(), 0);
        std::fill(strides_.begin(), strides_.end(), 0);
        for (size_t i = 0; i < MAX_DIMS; ++i)
        {
            if (shape[i] != 0)
            {
                shape_[i] = shape[i];
                dims_++;
            }
        }
        calculateSizeAndStrides();
    }

~NDArray()

template<typename T >

pxl::NDArray< T >::~NDArray ( )

default

Member Function Documentation

at() [1/2]

template<typename T >

template<typename... Idxs>

T& pxl::NDArray< T >::at ( Idxs...  idxs )

inline

Definition at line 214 of file ndarray.hpp.

    {
        return const_cast<T&>(static_cast<const NDArray&>(*this).at(idxs...));
    }

at() [2/2]

template<typename T >

template<typename... Idxs>

const T& pxl::NDArray< T >::at ( Idxs...  idxs ) const

inline

Definition at line 220 of file ndarray.hpp.

    {
        std::vector<std::int64_t> indices = {idxs...};
        if (indices.size() != static_cast<size_t>(dims_))
        {
            throw std::out_of_range("Number of indices does not match ndarray dimensions");
        }
        for (size_t i = 0; i < indices.size(); ++i)
        {
            if (indices[i] < 0 || indices[i] >= shape_[i])
            {
                throw std::out_of_range("Index out of bounds");
            }
        }
        return operator()(idxs...);
    }

data() [1/2]

template<typename T >

T* pxl::NDArray< T >::data ( )

inline

Definition at line 84 of file ndarray.hpp.

    {
        return reinterpret_cast<T*>(data_);
    }

data() [2/2]

template<typename T >

const T* pxl::NDArray< T >::data ( ) const

inline

Definition at line 88 of file ndarray.hpp.

    {
        return reinterpret_cast<const T*>(data_);
    }

dims()

template<typename T >

std::int64_t pxl::NDArray< T >::dims ( ) const

inline

Definition at line 106 of file ndarray.hpp.

    {
        return dims_;
    }

elemSize()

template<typename T >

std::int64_t pxl::NDArray< T >::elemSize ( ) const

inline

Definition at line 110 of file ndarray.hpp.

    {
        return elemSize_;
    }

numElements()

template<typename T >

std::int64_t pxl::NDArray< T >::numElements ( ) const

inline

Definition at line 118 of file ndarray.hpp.

    {
        return numElements_;
    }

operator const T &()

template<typename T >

pxl::NDArray< T >::operator const T & ( ) const

inline

Definition at line 188 of file ndarray.hpp.

    {
        if (dims_ != 0)
        {
            throw std::logic_error("Scalar conversion only available for 0-dimensional ndarrays");
        }
        return *reinterpret_cast<const T*>(data_);
    }

operator typename std::enable_if_t< std::is_same_v< U, std::remove_const_t< T >>, T & >()

template<typename T >

template<typename U = T>

pxl::NDArray< T >::operator typename std::enable_if_t< std::is_same_v< U, std::remove_const_t< T >>, T & > ( )

inline

Definition at line 179 of file ndarray.hpp.

    {
        if (dims_ != 0)
        {
            throw std::logic_error("Scalar conversion only available for 0-dimensional ndarrays");
        }
        return *reinterpret_cast<T*>(data_);
    }

operator()() [1/2]

template<typename T >

template<typename... Idxs>

T& pxl::NDArray< T >::operator() ( Idxs...  idxs )

inline

Definition at line 124 of file ndarray.hpp.

    {
        return const_cast<T&>(static_cast<const NDArray&>(*this)(idxs...));
    }

operator()() [2/2]

template<typename T >

template<typename... Idxs>

const T& pxl::NDArray< T >::operator() ( Idxs...  idxs ) const

inline

Definition at line 130 of file ndarray.hpp.

    {
#ifndef NDEBUG
        // Debug mode: perform bounds checking
        std::vector<std::int64_t> indices = {idxs...};
        if (indices.size() != static_cast<size_t>(dims_))
        {
            throw std::out_of_range("Number of indices does not match ndarray dimensions");
        }
        for (size_t i = 0; i < indices.size(); ++i)
        {
            if (indices[i] < 0 || indices[i] >= shape_[i])
            {
                throw std::out_of_range("Index out of bounds");
            }
        }
#endif
        return reinterpret_cast<const T*>(data_)[computeOffset({idxs...})];
    }

operator[]() [1/2]

template<typename T >

NDArray<T> pxl::NDArray< T >::operator[] ( std::int64_t  idx )

inline

Definition at line 151 of file ndarray.hpp.

    {
        auto const_result = static_cast<const NDArray&>(*this)[idx];
        return NDArray<T>(
            const_cast<T*>(const_result.data()),
            const_result.shape());
    }

operator[]() [2/2]

template<typename T >

NDArray<const T> pxl::NDArray< T >::operator[] ( std::int64_t  idx ) const

inline

Definition at line 159 of file ndarray.hpp.

    {
#ifndef NDEBUG
        // Debug mode: perform bounds checking
        if (idx < 0 || idx >= shape_[0])
        {
            throw std::out_of_range("Index out of bounds for first dimension");
        }
#endif
        ShapeArray new_shape;
        std::fill(new_shape.begin(), new_shape.end(), 0);
        std::copy(shape_.begin() + 1, shape_.end(), new_shape.begin());
 
        return NDArray<const T>(
            reinterpret_cast<const T*>(data_) + idx * strides_[0],
            new_shape);
    }

scalar() [1/2]

template<typename T >

T& pxl::NDArray< T >::scalar ( )

inline

Definition at line 198 of file ndarray.hpp.

    {
        return const_cast<T&>(static_cast<const NDArray&>(*this).scalar());
    }

scalar() [2/2]

template<typename T >

const T& pxl::NDArray< T >::scalar ( ) const

inline

Definition at line 203 of file ndarray.hpp.

    {
        if (dims_ != 0)
        {
            throw std::logic_error("scalar() only available for 0-dimensional ndarrays");
        }
        return *reinterpret_cast<const T*>(data_);
    }

setData()

template<typename T >

void pxl::NDArray< T >::setData ( void *  data )

inline

Definition at line 93 of file ndarray.hpp.

    {
        data_ = data;
    }

shape()

template<typename T >

const ShapeArray& pxl::NDArray< T >::shape ( ) const

inline

Definition at line 98 of file ndarray.hpp.

    {
        return shape_;
    }

size()

template<typename T >

std::int64_t pxl::NDArray< T >::size ( ) const

inline

Definition at line 114 of file ndarray.hpp.

    {
        return size_;
    }

strides()

template<typename T >

const StridesArray& pxl::NDArray< T >::strides ( ) const

inline

Definition at line 102 of file ndarray.hpp.

    {
        return strides_;
    }

Member Data Documentation

MAX_DIMS

template<typename T >

constexpr std::int64_t pxl::NDArray< T >::MAX_DIMS = 10

staticconstexpr

Definition at line 27 of file ndarray.hpp.

---

The documentation for this class was generated from the following files:

• direction.hpp
• ndarray.hpp