selection.hpp

Go to the documentation of this file.

//
// (c) Copyright 2014 DESY, Eugen Wintersberger <eugen.wintersberger@desy.de>
//
// This file is part of libpniio.
//
// libpniio 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.
//
// libpniio 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 libpniio.  If not, see <http://www.gnu.org/licenses/>.
// ===========================================================================
//
// Created on: Aug 1, 2014
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//
#pragma once

#include "type_imp.hpp"


namespace pni{
namespace io{
namespace nx{
namespace h5{    

    class selection
    {
        private:
            type_imp::index_vector_type _offset;
            type_imp::index_vector_type _stride;
            type_imp::index_vector_type _count;

        public:
            //----------------------------------------------------------------
            //                Constructors
            //----------------------------------------------------------------
            selection() noexcept;

            //----------------------------------------------------------------
            selection(size_t n);

            //----------------------------------------------------------------
            //               Data access methods
            //----------------------------------------------------------------
            const type_imp::index_vector_type &offset() const noexcept;

            //----------------------------------------------------------------
            void offset(const type_imp::index_vector_type &offset);

            //----------------------------------------------------------------
            void offset(type_imp::index_type value) noexcept;
            
            //----------------------------------------------------------------
            void offset(size_t index,size_t value);

            //----------------------------------------------------------------
            const type_imp::index_vector_type &stride() const noexcept;

            //----------------------------------------------------------------
            void stride(const type_imp::index_vector_type &value);

            //----------------------------------------------------------------
            void stride(type_imp::index_type value) noexcept;

            //----------------------------------------------------------------
            void stride(size_t index,type_imp::index_type value);
            
            //----------------------------------------------------------------
            const type_imp::index_vector_type &count() const noexcept;

            //----------------------------------------------------------------
            void count(const type_imp::index_vector_type &value);

            //----------------------------------------------------------------
            void count(type_imp::index_type value) noexcept;

            //----------------------------------------------------------------
            void count(size_t index,type_imp::index_type value);

            //----------------------------------------------------------------
            void update(const type_imp::selection_vector_type &s);

    };

    size_t effective_rank(const selection &s) noexcept;

    //------------------------------------------------------------------------
    type_imp::index_vector_type effective_shape(const selection &s);

    //------------------------------------------------------------------------
    size_t size(const selection &s) noexcept;

    //------------------------------------------------------------------------
    selection create_selection(const type_imp::selection_vector_type &s);

    //------------------------------------------------------------------------
    type_imp::selection_vector_type create_slice_vector(const selection &s);



//end of namespace
}
}
}
}