indexedTensorWritable.h

Go to the documentation of this file.

// Xerus - A General Purpose Tensor Library
// Copyright (C) 2014-2017 Benjamin Huber and Sebastian Wolf. 
// 
// Xerus is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
// 
// Xerus 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 Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
// along with Xerus. If not, see <http://www.gnu.org/licenses/>.
//
// For further information on Xerus visit https://libXerus.org 
// or contact us at contact@libXerus.org.

#pragma once

#include "indexedTensorReadOnly.h"

namespace xerus {
    namespace internal {
        template<class tensor_type>
        class IndexedTensorWritable : public IndexedTensorReadOnly<tensor_type> {
        public:
            tensor_type* tensorObject;
            
            bool deleteTensorObject;
            
        protected:
            IndexedTensorWritable() = delete;
            
            IndexedTensorWritable(const IndexedTensorWritable &_other ) = delete;
            
            IndexedTensorWritable(IndexedTensorWritable &&_other ) noexcept;
            
            IndexedTensorWritable(tensor_type* const _tensorObject, const std::vector<Index>&  _indices, const bool _takeOwnership);
            
            IndexedTensorWritable(tensor_type* const _tensorObject,       std::vector<Index>&& _indices, const bool _takeOwnership);
            
        public:
            /*- - - - - - - - - - - - - - - - - - - - - - - - - - Destructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
            virtual ~IndexedTensorWritable();
            
            /*- - - - - - - - - - - - - - - - - - - - - - - - - - Other - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
            
            bool is_owner() const;
            
            void indexed_assignement(IndexedTensorReadOnly<Tensor>&& _rhs);
            
            void indexed_assignement(IndexedTensorReadOnly<TensorNetwork>&& _rhs);
            
            void indexed_plus_equal(IndexedTensorReadOnly<tensor_type>&& _rhs);
            
            void indexed_minus_equal(IndexedTensorReadOnly<tensor_type>&& _rhs);
            
            void perform_traces();
        };
        
        
        void evaluate(IndexedTensorWritable<Tensor>&& _out, IndexedTensorReadOnly<Tensor>&& _base);
    }
}