DimensionIndex.h

Go to the documentation of this file.

/*
 * MIT License
 * 
 * Copyright (c) 2018 PulsarSearchSoft
 * 
 * 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 PSS_ASTROTYPES_MULTIARRAY_DIMENSIONINDEX_H
#define PSS_ASTROTYPES_MULTIARRAY_DIMENSIONINDEX_H

#include "DimensionSize.h"


namespace pss {
namespace astrotypes {

template<typename Dimension>
class DimensionIndex
{
    public:
        explicit DimensionIndex(std::size_t);
        ~DimensionIndex();
        operator std::size_t& ();
        operator std::size_t () const;

        inline DimensionSize<Dimension> operator-(DimensionIndex<Dimension> const&) const;
        inline DimensionIndex<Dimension> operator+(DimensionSize<Dimension> const&) const;

        bool operator<(DimensionIndex<Dimension> const&) const;
        DimensionIndex<Dimension>& operator++();

    private:
        std::size_t _index;
        
};

} // namespace astrotypes
} // namespace pss
#include "detail/DimensionIndex.cpp"

#endif // PSS_ASTROTYPES_MULTIARRAY_DIMENSIONINDEX_H