collection_of_3d_arrays.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_collection_of_3d_arrays_hpp
#define fiber_collection_of_3d_arrays_hpp

#include "_3d_array.hpp"

#include <boost/scoped_array.hpp>

namespace Fiber
{

template <typename T> class CollectionOf2dSlicesOf3dArrays;
template <typename T> class CollectionOf1dSlicesOf3dArrays;
template <typename T> class CollectionOf2dSlicesOfConst3dArrays;
template <typename T> class CollectionOf1dSlicesOfConst3dArrays;
template <typename T>
class CollectionOf3dArrays
{
public:
    CollectionOf3dArrays();
    explicit CollectionOf3dArrays(size_t arrayCount);

    void set_size(size_t new_size);
    size_t size() const;

    _3dArray<T>& operator[](size_t index);
    const _3dArray<T>& operator[](size_t index) const;

    void fill(const T& value);

    CollectionOf2dSlicesOf3dArrays<T> slice(size_t index2);
    CollectionOf2dSlicesOfConst3dArrays<T> const_slice(size_t index2) const;
    CollectionOf1dSlicesOf3dArrays<T> slice(size_t index1, size_t index2);
    CollectionOf1dSlicesOfConst3dArrays<T> const_slice(size_t index1, size_t index2) const;

private:
    _3dArray<T>& array(size_t index);
    const _3dArray<T>& array(size_t index) const;
    void check_array_index(size_t array_index) const;

private:
    // Disable copy constructor and assignment operator
    CollectionOf3dArrays(const CollectionOf3dArrays& rhs);
    CollectionOf3dArrays& operator=(const CollectionOf3dArrays& rhs);

private:
    size_t m_size;
    boost::scoped_array<_3dArray<T> > m_arrays;
};

template <typename T>
class CollectionOf2dSlicesOf3dArrays
{
public:
    CollectionOf2dSlicesOf3dArrays(CollectionOf3dArrays<T>& collection, size_t index2);

    typedef _2dSliceOfConst3dArray<T> ConstSlice;
    typedef _2dSliceOf3dArray<T> Slice;

    CollectionOf2dSlicesOf3dArrays& self();

    _2dSliceOfConst3dArray<T> operator[](size_t index) const;
    _2dSliceOf3dArray<T> operator[](size_t index);

    size_t size() const;

private:
    CollectionOf3dArrays<T>& m_collection;
    size_t m_index2;
};

template <typename T>
class CollectionOf2dSlicesOfConst3dArrays
{
public:
    CollectionOf2dSlicesOfConst3dArrays(
            const CollectionOf3dArrays<T>& collection, size_t index2);

    typedef _2dSliceOfConst3dArray<T> ConstSlice;

    _2dSliceOfConst3dArray<T> operator[](size_t index) const;

    size_t size() const;

private:
    const CollectionOf3dArrays<T>& m_collection;
    size_t m_index2;
};

template <typename T>
class CollectionOf1dSlicesOf3dArrays
{
public:
    CollectionOf1dSlicesOf3dArrays(CollectionOf3dArrays<T>& collection,
                                   size_t index1, size_t index2);

    typedef _1dSliceOfConst3dArray<T> ConstSlice;
    typedef _1dSliceOf3dArray<T> Slice;

    CollectionOf1dSlicesOf3dArrays& self();

    _1dSliceOfConst3dArray<T> operator[](size_t index) const;
    _1dSliceOf3dArray<T> operator[](size_t index);

    size_t size() const;

private:
    CollectionOf3dArrays<T>& m_collection;
    size_t m_index1, m_index2;
};

template <typename T>
class CollectionOf1dSlicesOfConst3dArrays
{
public:
    CollectionOf1dSlicesOfConst3dArrays(
            const CollectionOf3dArrays<T>& collection, size_t index1, size_t index2);

    typedef _1dSliceOfConst3dArray<T> ConstSlice;

    _1dSliceOfConst3dArray<T> operator[](size_t index) const;

    size_t size() const;

private:
    const CollectionOf3dArrays<T>& m_collection;
    size_t m_index1, m_index2;
};

} // namespace Fiber

#include "collection_of_3d_arrays_imp.hpp"

#endif