odmemory.h

Go to the documentation of this file.

#ifndef odmemory_h
#define odmemory_h
/*
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          Jan 2009
 RCS:           $Id$
________________________________________________________________________

*/

#include "commondefs.h"
#include "paralleltask.h"

template <class T> class ValueSeries;


namespace OD
{
    enum                PtrPolicy { UsePtr, CopyPtr, TakeOverPtr };
}



// 1M operations min per thread
#define mODMemMinThreadSize 131072

namespace OD
{
    template <class T> mGlobal(Basic) void memValueSet(T*,T,od_int64,
                                                       TaskRunner* taskrun=0);
}

template <class T>
mClass(Basic) MemSetter : public ParallelTask
{ mODTextTranslationClass(MemSetter);
public:

                MemSetter();
                MemSetter(T*,T val,od_int64 sz);
                MemSetter(ValueSeries<T>&,T val,od_int64 sz);

    typedef T   (*ValueFunc)();
    void        setValueFunc(ValueFunc valfunc) { valfunc_ = valfunc; }
    void        setValue( const T& val )        { val_ = val; }
    void        setTarget( T* ptr )             { ptr_ = ptr; vs_ = 0; }
    void        setTarget( ValueSeries<T>& vs ) { ptr_ = vs.arr(); vs_ = &vs; }
    void        setSize( od_int64 sz )          { sz_ = sz; }

    uiString    uiMessage() const       { return tr("Value setter"); }
    uiString    uiNrDoneText() const    { return sPosFinished(); }


protected:

    od_int64    nrIterations() const            { return sz_; }
    int         minThreadSize() const           { return mODMemMinThreadSize; }
    bool        setPtr(od_int64 start,od_int64 size);

    ValueSeries<T>*     vs_;
    T*                  ptr_;
    od_int64            sz_;
    T                   val_;
    ValueFunc           valfunc_;

private:

    bool        doPrepare(int);
    bool        doWork(od_int64,od_int64,int);

};


template <class T>
mClass(Basic) MemCopier : public ParallelTask
{ mODTextTranslationClass(MemCopier);
public:

                MemCopier();
                MemCopier(T*,const T*,od_int64 sz);
                MemCopier(T*,const ValueSeries<T>&,od_int64 sz);
                MemCopier(ValueSeries<T>&,const T*,od_int64 sz);
                MemCopier(ValueSeries<T>&,const ValueSeries<T>&,od_int64 sz);

    void        setInput( const T* ptr )        { inptr_ = ptr; invs_ = 0; }
    void        setInput( const ValueSeries<T>& vs ) {  inptr_ = vs.arr();
                                                        invs_ = &vs; }
    void        setOutput( T* ptr )             { outptr_ = ptr; outvs_ = 0; }
    void        setOutput( ValueSeries<T>& vs ) { outptr_ = vs.arr();
                                                  outvs_ = &vs; }
    void        setSize(od_int64 sz)            { sz_ = sz; }

    uiString    uiMessage() const       { return tr("Value copier"); }
    uiString    uiNrDoneText() const    { return sPosFinished(); }


protected:

    od_int64    nrIterations() const            { return sz_; }
    int         minThreadSize() const           { return mODMemMinThreadSize; }
    inline bool setPtr(od_int64 start,od_int64 size);

    const T*            inptr_;
    const ValueSeries<T>* invs_;
    T*                  outptr_;
    ValueSeries<T>*     outvs_;
    od_int64            sz_;

private:

    bool        doPrepare(int);
    bool        doWork(od_int64,od_int64,int);

};


template <class T>
mClass(Basic) MemValReplacer : public ParallelTask
{ mODTextTranslationClass(MemValReplacer);
public:
                MemValReplacer();
                MemValReplacer(T*,const T& fromval,const T& toval,od_int64 sz);
                MemValReplacer(ValueSeries<T>&,const T& from,const T& to,
                               od_int64 sz);

    void        setFromValue(const T& val)      { fromval_ = val; }
    void        setToValue(const T& val)        { toval_ = val; }
    void        setPtr(T* ptr)                  { ptr_ = ptr; vs_ = 0; }
    void        setPtr(ValueSeries<T>& vs)      { ptr_ = vs.arr(); vs_ = &vs; }
    void        setSize(od_int64 sz)            { sz_ = sz; }

    uiString    uiMessage() const       { return tr("Value replacer"); }
    uiString    uiNrDoneText() const    { return sPosFinished(); }


protected:

    od_int64            nrIterations() const    { return sz_; }
    int                 minThreadSize() const   { return mODMemMinThreadSize; }
    bool                setPtr(od_int64 start,od_int64 size);

    ValueSeries<T>*     vs_;
    T*                  ptr_;
    od_int64            sz_;
    T                   toval_;
    T                   fromval_;

private:

    bool        doPrepare(int);
    bool        doWork(od_int64,od_int64,int);

};


namespace OD { mGlobal(Basic) void sysMemCopy(void*,const void*,od_int64); }

#include "valseries.h"


template <class T> inline
MemSetter<T>::MemSetter()
    : ptr_( 0 )
    , vs_( 0 )
    , sz_( -1 )
    , valfunc_( 0 )
{}


template <class T> inline
MemSetter<T>::MemSetter( T* ptr, T val, od_int64 sz )
    : ptr_( ptr )
    , vs_( 0 )
    , val_( val )
    , sz_( sz )
    , valfunc_( 0 )
{}


template <class T> inline
MemSetter<T>::MemSetter( ValueSeries<T>& vs, T val, od_int64 sz )
    : ptr_( vs.arr() )
    , vs_( &vs )
    , val_( val )
    , sz_( sz )
    , valfunc_( 0 )
{}


template <class T> inline
bool MemSetter<T>::doPrepare( int )
{ return ptr_ || vs_; }


template <class T> inline
bool MemSetter<T>::doWork( od_int64 start, od_int64 stop, int )
{
    if ( ptr_ )
    {
        if ( valfunc_ )
        {
            T* ptr = ptr_+start;
            T* stopptr = ptr_+stop;
            while ( ptr<=stopptr )
            {
                *ptr = valfunc_();
                ptr++;
            }

            return true;
        }
        else
        {
            return setPtr( start, stop-start+1 );
        }
    }

    if ( valfunc_ )
    {
        for ( od_int64 idx=start; idx<=stop; idx++ )
            { vs_->setValue( idx, valfunc_() ); }
    }
    else
    {
        for ( od_int64 idx=start; idx<=stop; idx++ )
            { vs_->setValue( idx, val_ ); }
    }

    return true;
}


namespace OD
{
    mGlobal(Basic) void sysMemSet(void*,int,size_t);

    template <class T> mGlobal(Basic) T* sysMemValueSet(T*,T,od_int64 nrsamp);
}

template <> inline
bool MemSetter<char>::setPtr( od_int64 start, od_int64 size )
{
    OD::sysMemSet( ptr_+start, (int)val_, (size_t) size );
    addToNrDone( size );
    return true;
}


template <> inline
bool MemSetter<unsigned char>::setPtr( od_int64 start, od_int64 size )
{
    OD::sysMemSet( ptr_+start, (int)val_, (size_t) size );
    addToNrDone( size );
    return true;
}


template <> inline
bool MemSetter<bool>::setPtr( od_int64 start, od_int64 size )
{
    OD::sysMemSet( ptr_+start, (int)val_, (size_t) size );
    addToNrDone( size );
    return true;
}


#define mODMemSetterFullImpl(Type) \
    Type* ptr = ptr_ + start; \
    const Type* stopptr = ptr + size; \
    while ( ptr != stopptr ) \
    { \
        *ptr = val_; \
        ptr++; \
    } \
 \
    return true;


namespace OD { mGlobal(Basic) void sysMemZero(void*,size_t); }

#define mODMemSpecialImpl( Type ) \
template <> inline \
bool MemSetter<Type>::setPtr( od_int64 start, od_int64 size ) \
{ \
    if ( val_==0 ) \
        OD::sysMemZero( ptr_+start, size*sizeof(Type) ); \
    else \
        OD::sysMemValueSet( ptr_+start, val_, size ); \
    \
    addToNrDone( size ); \
    return true; \
}


mODMemSpecialImpl( float );
mODMemSpecialImpl( double );
mODMemSpecialImpl( int );
mODMemSpecialImpl( unsigned int );
mODMemSpecialImpl( short );
mODMemSpecialImpl( unsigned short );
mODMemSpecialImpl( od_int64 );
mODMemSpecialImpl( od_uint64 );



template <class T> inline
bool MemSetter<T>::setPtr( od_int64 start, od_int64 size )
{
    OD::sysMemValueSet( ptr_+start, val_, size );
    addToNrDone( size );
    return true;
}

#undef mODMemSpecialImpl
#undef mODMemSetterFullImpl


template <class T> inline
MemCopier<T>::MemCopier()
    : sz_(0), inptr_(0), invs_(0), outptr_(0), outvs_(0)                {}

template <class T> inline
MemCopier<T>::MemCopier( T* o, const T* i, od_int64 sz )
    : sz_(sz), inptr_(i), invs_(0), outptr_(o), outvs_(0)               {}

template <class T> inline
MemCopier<T>::MemCopier( ValueSeries<T>& o, const T* i, od_int64 sz )
    : sz_(sz), inptr_(i), invs_(0), outptr_(o.arr()), outvs_(&o)        {}

template <class T> inline
MemCopier<T>::MemCopier( T* o, const ValueSeries<T>& i, od_int64 sz )
    : sz_(sz), inptr_(i.arr()), invs_(&i), outptr_(o), outvs_(0)        {}

template <class T> inline
MemCopier<T>::MemCopier( ValueSeries<T>& o, const ValueSeries<T>& i,
                                od_int64 sz)
    : sz_(sz), inptr_(i.arr), invs_(&i), outptr_(o.arr()), outvs_(&o)   {}


template <class T> inline
bool MemCopier<T>::doPrepare( int )
{ return (inptr_ || invs_) && (outptr_ || outvs_); }


template <class T> inline
bool MemCopier<T>::doWork( od_int64 start, od_int64 stop, int )
{
    if ( inptr_ && outptr_ )
        return setPtr( start, stop-start+1 );

    if ( outptr_ )
    {
        for ( od_int64 idx=start; idx<=stop; idx++ )
            { outptr_[idx] = invs_->value( idx ); }
    }
    else if ( inptr_ )
    {
        for ( od_int64 idx=start; idx<=stop; idx++ )
            { outvs_->setValue( idx, inptr_[idx] ); }
    }
    else
    {
        for ( od_int64 idx=start; idx<=stop; idx++ )
            { outvs_->setValue( idx, invs_->value(idx)); }
    }
    return true;
}



template <class T> inline
bool MemCopier<T>::setPtr( od_int64 start, od_int64 size )
{
    OD::sysMemCopy( outptr_+start, inptr_+start, size * sizeof(T) );
    addToNrDone( size );
    return true;
}


template <class T> inline
MemValReplacer<T>::MemValReplacer( T* ptr, const T& fromval, const T& toval,
                                   od_int64 sz )
    : ptr_( ptr )
    , vs_( 0 )
    , fromval_( fromval )
    , toval_( toval )
    , sz_( sz )
{}


template <class T> inline
MemValReplacer<T>::MemValReplacer(ValueSeries<T>& vs, const T& fromval,
                                  const T& toval,
                                  od_int64 sz)
    : ptr_( vs.arr() )
    , vs_( &vs )
    , toval_( toval )
    , fromval_( fromval )
    , sz_( sz )
{}


template <class T> inline
bool MemValReplacer<T>::doPrepare( int )
{ return ptr_ || vs_; }


template <class T> inline
bool MemValReplacer<T>::doWork( od_int64 start, od_int64 stop, int )
{
    if ( ptr_ )
        return setPtr( start, stop-start+1 );

    for ( od_int64 idx=start; idx<=stop; idx++ )
    {
        if ( vs_->value(idx)==fromval_ )
            vs_->setValue( idx, toval_ );
    }

    return true;
}

template <class T> inline
bool MemValReplacer<T>::setPtr( od_int64 start, od_int64 size )
{
    T* ptr = ptr_ + start;
    const T* stopptr = ptr + size;
    while ( ptr != stopptr )
    {
        if ( *ptr==fromval_ )
            *ptr = toval_;

        ptr++;
    }

    return true;
}



#define cMinMemValSetParallelSize 400

namespace OD
{

template <class T>
inline T* sysMemValueSet( T* ptr, T val , od_int64 size )
{
    if ( !ptr || size<=0 )
        return ptr ? ptr : 0;

    const T* stopptr = ptr + size;
    while ( ptr != stopptr )
        *ptr++ = val;

    return ptr;
}


template <class T>
inline void memValueSet( T* arr, T val , od_int64 sz, TaskRunner* taskrun )
{
    if ( sz < cMinMemValSetParallelSize )
    {
        sysMemValueSet( arr, val, sz );
        return;
    }

    MemSetter<T> msetter( arr, val, sz );
    taskrun ? taskrun->execute( msetter )
            : msetter.execute();
}

} // namespace OD


#endif