ArrayAccessor3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: ArrayAccessor3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D array accessor class.
> Created Time: 2017/01/28
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_ARRAY_ACCESSOR3_H
#define CUBBYFLOW_ARRAY_ACCESSOR3_H

#include <Core/Array/ArrayAccessor.h>
#include <Core/Size/Size3.h>

namespace CubbyFlow
{
    template <typename T>
    class ArrayAccessor<T, 3> final {
    public:
        ArrayAccessor();

        ArrayAccessor(const Size3& size, T* const data);

        ArrayAccessor(
            size_t width, size_t height, size_t depth, T* const data);

        ArrayAccessor(const ArrayAccessor& other);

        void Set(const ArrayAccessor& other);

        void Reset(const Size3& size, T* const data);

        void Reset(size_t width, size_t height, size_t depth, T* const data);

        T& At(size_t i);

        const T& At(size_t i) const;

        T& At(const Point3UI& pt);

        const T& At(const Point3UI& pt) const;

        T& At(size_t i, size_t j, size_t k);

        const T& At(size_t i, size_t j, size_t k) const;

        T* const begin() const;

        T* const end() const;

        T* begin();

        T* end();

        Size3 size() const;

        size_t Width() const;

        size_t Height() const;

        size_t Depth() const;

        T* const data() const;

        void Swap(ArrayAccessor& other);

        template <typename Callback>
        void ForEach(Callback func) const;

        template <typename Callback>
        void ForEachIndex(Callback func) const;

        template <typename Callback>
        void ParallelForEach(Callback func);

        template <typename Callback>
        void ParallelForEachIndex(Callback func) const;

        size_t Index(const Point3UI& pt) const;

        size_t Index(size_t i, size_t j, size_t k) const;

        T& operator[](size_t i);

        const T& operator[](size_t i) const;

        T& operator()(const Point3UI& pt);

        const T& operator()(const Point3UI& pt) const;

        T& operator()(size_t i, size_t j, size_t k);

        const T& operator()(size_t i, size_t j, size_t k) const;

        ArrayAccessor& operator=(const ArrayAccessor& other);

        operator ConstArrayAccessor<T, 3>() const;

    private:
        Size3 m_size;
        T* m_data;
    };

    template <typename T> using ArrayAccessor3 = ArrayAccessor<T, 3>;

    template <typename T>
    class ConstArrayAccessor<T, 3> {
    public:
        ConstArrayAccessor();

        ConstArrayAccessor(const Size3& size, const T* const data);

        ConstArrayAccessor(
            size_t width, size_t height, size_t depth, const T* const data);

        explicit ConstArrayAccessor(const ArrayAccessor<T, 3>& other);

        ConstArrayAccessor(const ConstArrayAccessor& other);

        const T& At(size_t i) const;

        const T& At(const Point3UI& pt) const;

        const T& At(size_t i, size_t j, size_t k) const;

        const T* const begin() const;

        const T* const end() const;

        Size3 size() const;

        size_t Width() const;

        size_t Height() const;

        size_t Depth() const;

        const T* const data() const;

        template <typename Callback>
        void ForEach(Callback func) const;

        template <typename Callback>
        void ForEachIndex(Callback func) const;

        template <typename Callback>
        void ParallelForEachIndex(Callback func) const;

        size_t Index(const Point3UI& pt) const;

        size_t Index(size_t i, size_t j, size_t k) const;

        const T& operator[](size_t i) const;

        const T& operator()(const Point3UI& pt) const;

        const T& operator()(size_t i, size_t j, size_t k) const;

    private:
        Size3 m_size;
        const T* m_data;
    };

    template <typename T> using ConstArrayAccessor3 = ConstArrayAccessor<T, 3>;
}

#include <Core/Array/ArrayAccessor3-Impl.h>

#endif