_3d_array.hpp

// Copyright (C) 2011-2012 by the Bem++ Authors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#ifndef fiber_3d_array_hpp
#define fiber_3d_array_hpp

#include "../common/common.hpp"
#include "boost/operators.hpp"

#include <stdexcept>

#ifndef NDEBUG
#define FIBER_CHECK_ARRAY_BOUNDS
#endif

namespace Fiber
{

template <typename T> class _2dSliceOf3dArray;
template <typename T> class _1dSliceOf3dArray;
template <typename T> class Const2dSliceOf3dArray;
template <typename T> class Const1dSliceOf3dArray;
template <typename T>
class _3dArray : boost::additive<_3dArray<T>
        , boost::multiplicative<_3dArray<T>,T > >
{
public:
    _3dArray();
    _3dArray(size_t extent0, size_t extent1, size_t extent2);
    _3dArray(size_t extent0, size_t extent1, size_t extent2, T* data,
             bool strict = false);
    _3dArray(const _3dArray& other);
    _3dArray& operator=(const _3dArray& rhs);

    ~_3dArray();

    T& operator()(size_t index0, size_t index1, size_t index2);
    const T& operator()(size_t index0, size_t index1, size_t index2) const;

    _3dArray<T>& operator+=(const _3dArray<T>& other);
    _3dArray<T>& operator*=(const T& other);


//    so far unused, to be implemented later
//    _2dSliceOf3dArray slice(size_t index2);
//    Const2dSliceOf3dArray const_slice(size_t index2) const;

//    _1dSliceOf3dArray slice(size_t index1, size_t index2);
//    Const1dSliceOf3dArray const_slice(size_t index2) const;

    size_t extent(size_t dimension) const;
    void set_size(size_t extent0, size_t extent1, size_t extent2);
    bool is_empty() const;

    typedef T* iterator;
    typedef const T* const_iterator;

    iterator begin();
    const_iterator begin() const;
    iterator end();
    const_iterator end() const;

private:
    void init_memory(size_t extent0, size_t extent1, size_t extent2);
    void init_empty();
    void free_memory();

#ifdef FIBER_CHECK_ARRAY_BOUNDS
    void check_dimension(size_t dimension) const;
    void check_extents(size_t extent0, size_t extent1, size_t extent2) const;
    void check_indices(size_t index0, size_t index1, size_t index2) const;
#endif

private:
    size_t m_extents[3];
    bool m_owns;
    bool m_strict;
    T* m_storage;
};

template <typename T>
class _2dSliceOf3dArray
{
public:
    _2dSliceOf3dArray(_3dArray<T>& array, size_t index2);

    _2dSliceOf3dArray& self();

    const T& operator()(size_t index0, size_t index1) const;
    T& operator()(size_t index0, size_t index1);

    size_t extent(size_t dimension) const;

private:
    void check_dimension(size_t dimension) const;

private:
    _3dArray<T>& m_array;
    size_t m_index2;
};

template <typename T>
class _2dSliceOfConst3dArray
{
public:
    _2dSliceOfConst3dArray(const _3dArray<T>& array, size_t index2);

    const T& operator()(size_t index0, size_t index1) const;

    size_t extent(size_t dimension) const;

private:
    void check_dimension(size_t dimension) const;

private:
    const _3dArray<T>& m_array;
    size_t m_index2;
};

template <typename T>
class _1dSliceOf3dArray
{
public:
    _1dSliceOf3dArray(_3dArray<T>& array, size_t index1, size_t index2);

    _1dSliceOf3dArray& self();

    const T& operator()(size_t index0) const;
    T& operator()(size_t index0);

    size_t extent(size_t dimension) const;

private:
    void check_dimension(size_t dimension) const;

private:
    _3dArray<T>& m_array;
    size_t m_index1, m_index2;
};

template <typename T>
class _1dSliceOfConst3dArray
{
public:
    _1dSliceOfConst3dArray(const _3dArray<T>& array, size_t index1, size_t index2);

    const T& operator()(size_t index0) const;

    size_t extent(size_t dimension) const;

private:
    void check_dimension(size_t dimension) const;

private:
    const _3dArray<T>& m_array;
    size_t m_index1, m_index2;
};

} // namespace Fiber

#include "_3d_array_imp.hpp"

#endif