posidxpairdataset.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          July 2004/Oct 2013/Mar 2016
________________________________________________________________________

-*/

#include "generalmod.h"
#include "posidxpair.h"
#include "sets.h"
#include "ranges.h"
#include "od_iosfwd.h"
namespace PosInfo { class CubeData; }
class TrcKeySampling;


namespace Pos
{

class IdxPairDataSet;
typedef void (*EntryCreatedFn)(IdxPairDataSet&,int spos_i,int spos_j);

mExpClass(General) IdxPairDataSet
{
public:

    typedef IdxPair::IdxType            IdxType;
    typedef TypeSet<IdxType>::size_type ArrIdxType;
    typedef od_int64                    ObjSzType;
    typedef od_int64                    GlobIdxType;


    struct SPos
    {
                        SPos( ArrIdxType ii=-1, ArrIdxType jj=-1 )
                            : i(ii), j(jj)      {}
        void            reset()         { i = j = -1; }
        inline bool     operator ==( const SPos& oth ) const
                                        { return i == oth.i && j == oth.j; }
        inline bool     operator !=( const SPos& oth ) const
                                        { return i != oth.i || j != oth.j; }
        inline bool     operator>(const SPos&) const;
        inline bool     operator<(const SPos&) const;
        inline bool     isValid() const { return i > -1 && j > -1; }

        ArrIdxType      i, j;
    };


                        IdxPairDataSet(ObjSzType,bool allow_duplicate_idxs,
                                        bool manage_data=true);
                        IdxPairDataSet(const IdxPairDataSet&);
    virtual             ~IdxPairDataSet();
    IdxPairDataSet&     operator =(const IdxPairDataSet&);

    inline bool         isEmpty() const         { return frsts_.isEmpty(); }
    void                setEmpty();
    void                copyStructureFrom(const IdxPairDataSet&);

    ObjSzType           objSize() const                 { return objsz_; }
    bool                managesData() const             { return mandata_; };
    bool                allowsDuplicateIdxPairs() const { return allowdup_; }
    void                allowDuplicateIdxPairs(bool);
    bool                append(const IdxPairDataSet&);
    void                remove(const IdxPairDataSet&);
    void                remove(const TrcKeySampling& hrg,bool inside);
    void                remove(SPos); 
    void                remove(const TypeSet<SPos>&);

    inline SPos         find( const IdxPair& ip ) const
                                                { return findFirst(ip); }
    inline SPos         findFirst( const IdxPair& ip ) const
                                                { return findOccurrence(ip,0); }
    SPos                findOccurrence(const IdxPair&,int occ=0) const;
    bool                next(SPos&,bool skip_duplicate_idxpairs=false) const;
    bool                prev(SPos&,bool skip_duplicate_idxpairs=false) const;
    bool                isValid(SPos) const;
    bool                isValid(const IdxPair&) const;

    IdxPair             getIdxPair(SPos) const;
    const void*         getObj(SPos) const;
    const void*         get(SPos,IdxPair&) const;
    SPos                getPos(GlobIdxType) const;  
    SPos                add(const IdxPair&,const void* obj=0);
    void                set(SPos,const void* obj=0);
    void                set( const IdxPair& ip, const void* obj=0 )
                                                { set( findFirst(ip), obj ); }
    SPos                update(const IdxPair&,const void* obj=0);

    inline ArrIdxType   nrFirst() const         { return frsts_.size(); }
    ArrIdxType          nrSecond(IdxType firstidx) const;
    inline bool         includes( const IdxPair& ip ) const
                                                { return find(ip).j > -1; }
    bool                hasFirst(IdxType) const;
    bool                hasSecond(IdxType) const;
    IdxPair             firstIdxPair() const; 
    GlobIdxType         totalSize() const;
    Interval<IdxType>   firstRange() const;
    Interval<IdxType>   secondRange(IdxType firsidx=-1) const;

    bool                hasDuplicateIdxPairs() const;
    ArrIdxType          nrDuplicateIdxPairs() const;
    void                removeDuplicateIdxPairs();
    ArrIdxType          nrPos(ArrIdxType lineidx) const;

    void                extend(const IdxPairDelta& stepout,const IdxPairStep&,
                                bool avoiddups=true);
    void                add(const PosInfo::CubeData&,EntryCreatedFn fn=0);
    void                randomSubselect(GlobIdxType maxsz);

                        // I/O
    bool                dump(od_ostream&,bool binary) const;
    bool                slurp(od_istream&,bool binary);

                        // aliases
    inline ArrIdxType   nrInls() const              { return nrFirst(); }
    inline ArrIdxType   nrCrls( IdxType inl ) const { return nrSecond(inl); }
    inline ArrIdxType   nrRows() const              { return nrFirst(); }
    inline ArrIdxType   nrCols( IdxType row ) const { return nrSecond(row); }
    bool                hasInl( IdxType inl ) const { return hasFirst(inl); }
    bool                hasCrl( IdxType crl ) const { return hasSecond(crl); }
    inline bool         hasRow( IdxType row ) const { return hasFirst(row); }
    inline bool         hasCol( IdxType col ) const { return hasSecond(col); }
    Interval<IdxType>   inlRange() const            { return firstRange(); }
    Interval<IdxType>   rowRange() const            { return firstRange(); }
    Interval<IdxType>   crlRange( IdxType inl=-1 ) const
                                                    { return secondRange(inl); }
    Interval<IdxType>   colRange( IdxType row=-1 ) const
                                                    { return secondRange(row); }

                        // Maybe messing with managed objects in buf.
    bool                setObjSize(ObjSzType sz,ObjSzType offs_in_objs=-1,
                                    const void* initwith=0);
                        // offs_in_objs < 0: operate at end
    void                decrObjSize(ObjSzType,ObjSzType offs);
    bool                incrObjSize(ObjSzType,ObjSzType offs,const void* =0);

protected:

    typedef TypeSet<IdxType>    IdxSet;
    typedef od_int64            BufSzType;

    class ObjData
    {
    public:

        typedef unsigned char   BufType;

                                ObjData() : buf_(0), bufsz_(0)
                                                    { objs_.allowNull(true); }
                                ObjData(const ObjData&);
                                ~ObjData()          { delete [] buf_; }

        const void*             getObj(bool,ArrIdxType,ObjSzType) const;
        void                    putObj(bool,ArrIdxType,ObjSzType,const void*);
        bool                    addObjSpace(bool,ArrIdxType,ObjSzType);
        void                    removeObj(bool,ArrIdxType,ObjSzType);
        void                    decrObjSize(ObjSzType orgsz,ObjSzType newsz,
                                            ObjSzType at_offs);
        bool                    incrObjSize(ObjSzType,ObjSzType,ObjSzType,
                                            const void*);

    private:

        ObjectSet<const void>   objs_; // contains const bool* when mandata

        BufType*        buf_;
        BufSzType       bufsz_;
        bool            manageBufCapacity(ObjSzType);

    };

    const ObjSzType     objsz_;
    const bool          mandata_;
    bool                allowdup_;

    IdxSet              frsts_;
    ObjectSet<IdxSet>   scndsets_;
    ObjectSet<ObjData>  objdatas_;

    static ArrIdxType   findIndexFor(const IdxSet&,IdxType,bool* found=0);
    const void*         gtObj(const SPos&) const;
    bool                addObj(SPos&,IdxType,const void*);
    void                putObj(const SPos&,const void*);
    void                addEntry(const Pos::IdxPair&,const void*,SPos&);

    // All 'gt' functions return unchecked
    inline IdxType      gtFrst( const SPos& pos ) const
                                { return frsts_[pos.i]; }
    inline IdxType      gtScnd( const SPos& pos ) const
                                { return gtScndSet(pos)[pos.j]; }
    inline IdxPair      gtIdxPair( const SPos& pos ) const
                                { return IdxPair( gtFrst(pos), gtScnd(pos) ); }
    inline IdxSet&      gtScndSet( const SPos& pos )
                                { return *scndsets_[pos.i]; }
    inline const IdxSet& gtScndSet( const SPos& pos ) const
                                { return *scndsets_[pos.i]; }
    inline ObjData&     gtObjData( const SPos& pos )
                                { return *objdatas_[pos.i]; }
    inline const ObjData& gtObjData( const SPos& pos ) const
                                { return *objdatas_[pos.i]; }
    inline IdxSet&      gtScndSet( ArrIdxType idx )
                                { return *scndsets_[idx]; }
    inline const IdxSet& gtScndSet( ArrIdxType idx ) const
                                { return *scndsets_[idx]; }
    inline ObjData&     gtObjData( ArrIdxType idx )
                                { return *objdatas_[idx]; }
    inline const ObjData& gtObjData( ArrIdxType idx ) const
                                { return *objdatas_[idx]; }

};


inline bool IdxPairDataSet::SPos::operator >( const SPos& oth ) const
{
    if ( i > oth.i )
        return true;
    return i == oth.i && j > oth.j;
}


inline bool IdxPairDataSet::SPos::operator <( const SPos& oth ) const
{
    if ( i < oth.i )
        return true;
    return i == oth.i && j < oth.j;
}


} // namespace Pos