Container.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2022 Séon O'Shannon & eons LLC
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/common/Types.h"
#include "bio/common/macros/Macros.h"
#include "bio/common/Cast.h"
#include "SmartIterator.h"
#include <deque>
 
namespace bio {
 
class Iterator;
 
class Container
{
public:
 
    Container(
        const Index expectedSize = 2,
        std::size_t stepSize = sizeof(ByteStream));
 
    Container(const Container& other);
 
    virtual ~Container();
 
    virtual Index GetBeginIndex() const;
 
    virtual Index GetEndIndex() const;
 
    virtual Index GetCapacity() const;
 
    virtual Index GetAllocatedSize() const;
 
    virtual Index GetNumberOfElements() const;
 
    virtual bool IsFree(const Index index) const;
 
    virtual bool IsInRange(const Index index) const;
 
    virtual bool IsAllocated(const Index index) const;
 
    virtual void Expand();
 
    virtual Index Add(const ByteStream content);
 
    virtual Index Insert(
        const ByteStream content,
        const Index index
    );
 
    virtual ByteStream Access(const Index index);
 
    virtual const ByteStream Access(const Index index) const;
 
    inline ByteStream Access(const SmartIterator itt)
    {
        return Access(itt.GetIndex());
    }
 
    virtual const ByteStream Access(const SmartIterator itt) const
    {
        return Access(itt.GetIndex());
    }
 
    Index SeekTo(const ByteStream content) const;
 
    bool Has(const ByteStream content) const;
 
    virtual bool Erase(Index index);
 
    inline bool Erase(const SmartIterator itt)
    {
        return Erase(itt.GetIndex());
    }
 
    virtual void Clear();
 
    virtual void Import(const Container* other);
 
    virtual ByteStream operator[](const Index index);
 
    virtual const ByteStream operator[](const Index index) const;
 
    virtual ByteStream operator[](const SmartIterator itt);
 
    virtual const ByteStream operator[](const SmartIterator itt) const;
 
    virtual Iterator* ConstructClassIterator(const Index index = InvalidIndex()) const;
 
    virtual SmartIterator Begin() const;
 
    virtual SmartIterator End() const;
 
    template < typename T >
    std::vector< T > AsVector() const
    {
        std::vector< T > ret;
        for (
            SmartIterator rct = End();
            !rct.IsAtBeginning();
            --rct
            )
        {
            ret.push_back(rct.As< T >());
        }
        return ret;
    }
 
protected:
 
    virtual const std::size_t GetStepSize() const;
 
    virtual Index GetNextAvailableIndex();
 
    virtual bool AreEqual(
        Index internal,
        const ByteStream external
    ) const;
 
    unsigned char* m_store;
 
    Index m_size;
    Index m_firstFree;
    std::deque< Index > m_deallocated;
 
    mutable Iterator* m_tempItt;
};
 
} //bio namespace