array_holder_interface.hpp

//
// (c) Copyright 2013 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: 11 08, 2013
//     Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
//
#pragma once

#include <iostream>
#include "value.hpp"
#include "value_ref.hpp"

namespace pni{
namespace core{

    class array_holder_interface
    {
        public:
            typedef std::vector<size_t> element_index; 
            typedef std::vector<slice>  view_index;
            virtual type_id_t type_id() const = 0;
            
            //-----------------------------------------------------------------
            virtual size_t rank() const = 0;

            //-----------------------------------------------------------------
            virtual shape_t shape() const = 0;

            //-----------------------------------------------------------------
            virtual size_t size() const = 0;

            //-----------------------------------------------------------------
            virtual std::ostream &write(std::ostream &os) const = 0;

            //-----------------------------------------------------------------
            virtual std::istream &read(std::istream &is) = 0;

            //-----------------------------------------------------------------
            virtual array_holder_interface *clone() const = 0;

            //-----------------------------------------------------------------
            virtual string type_name() const = 0;

            //-----------------------------------------------------------------
            virtual value operator[](size_t i) const = 0;

            //-----------------------------------------------------------------
            virtual value_ref operator[](size_t i) = 0;

            //-----------------------------------------------------------------
            virtual value at(size_t i) const = 0;

            //-----------------------------------------------------------------
            virtual value_ref at(size_t i) = 0;

            //-----------------------------------------------------------------
            virtual const void *ptr() const = 0;

            //-----------------------------------------------------------------
            virtual value operator()(const element_index &index) const = 0;

            //-----------------------------------------------------------------
            virtual value_ref operator()(const element_index &index)  = 0;

    };


//end of namespace
}
}