slice.hpp

//
// (c) Copyright 2012 DESY, Eugen Wintersberger <eugen.wintersberger@desy.de>
//
// This file is part of libpnicore.
//
// libpnicore is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// libpnicore is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with libpnicore.  If not, see <http://www.gnu.org/licenses/>.
//
// ===========================================================================
//
// Created on: May 14, 2012
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//
#pragma once

#include <iostream>
#include <utility>

#include "../error/exceptions.hpp"

namespace pni{
namespace core{

    class slice
    {
        private:
            size_t _first;  
            size_t _last;   
            size_t _stride; 

            void _check_start_stop(const exception_record &o) const;

            //-----------------------------------------------------------------
            void _check_stride(const exception_record &o) const;
        public:
            //==============constructors and destructor========================
            slice() {}

            //-----------------------------------------------------------------
            explicit slice(size_t first,size_t last,size_t stride=1);

            //-----------------------------------------------------------------

            explicit slice(const std::initializer_list<size_t> &l);

            //-----------------------------------------------------------------
            explicit slice(size_t index);

            //-----------------------------------------------------------------
            ~slice(){}

            //===============assignment operators==============================
            slice &operator=(const slice &s);

            //=================public member methods===========================
            size_t first() const { return _first; }

            //-----------------------------------------------------------------
            size_t last() const { return _last; }

            //-----------------------------------------------------------------
            size_t stride() const { return _stride; }
    }; 

    std::ostream &operator<<(std::ostream &o,const slice &s);

    bool operator==(const slice &lhs,const slice &rhs);

    bool operator!=(const slice &lhs,const slice &rhs);

    //-------------------------------------------------------------------------

    size_t size(const slice &s);

    //-------------------------------------------------------------------------

    size_t span(const slice &s);

//end of namespace
}
}