index.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 "basic.h"

#include <atomic>
#include <bitset>
#include <vector>

namespace xerus {
    
    class Index {
    public:
        #ifndef XERUS_DISABLE_RUNTIME_CHECKS
            enum Flag {FIXED, INVERSE_SPAN, FRACTIONAL_SPAN, ASSINGED, OPEN, NUM_FLAGS};
        #else
            enum Flag {FIXED, INVERSE_SPAN, FRACTIONAL_SPAN, OPEN, NUM_FLAGS};
        #endif
        
    private:
        static std::atomic<uint64> idThreadInitCounter;
        
        static thread_local uint64 idCounter;
        
    public:
        uint64 valueId;
        
        size_t span = 1;
        
        size_t assingedDimension = 0;
        
        std::bitset<NUM_FLAGS> flags;
        
        
        
        Index();
        
        Index(const Index& _other) noexcept = default;
        
        Index(const int32 _i);
        
        Index(const uint32 _i) noexcept;
        
        Index(const int64 _i);
        
        Index(const uint64 _i) noexcept;

        explicit Index(const uint64 _valueId, const size_t _span) noexcept;
        
        explicit Index(const uint64 _valueId, const size_t _span, const Flag _flag1) noexcept;
        
        
        
        Index& operator=(const Index&) = default;
        
        void set_span(const size_t _degree);
        
        size_t actual_span(const size_t _degree) const;
        
        bool fixed() const;
        
        bool open() const;
        
        void open(const bool _open);
        
        size_t fixed_position() const;
        
        
        
        size_t dimension() const;
        
        Index operator^(const size_t _span) const;
        
        Index operator&(const size_t _span) const;
        
        Index operator/(const size_t _span) const;
        
        static bool all_open(const std::vector<Index>& _indices);
    };
    
    bool operator==(const Index& _a, const Index& _b);
    
    bool operator!=(const Index& _a, const Index& _b);
    
    bool operator<(const Index& _a, const Index& _b);
    
    std::ostream& operator<<(std::ostream& _out, const xerus::Index& _idx); 
}