GT_DARandom.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        GT_DARandom.h ( GT Library, C++)
 *
 * COMMENTS:    An example of a non-data driven array.  This array computes
 *              random values based on a random number seed.
 */

#ifndef __GT_DARandom__
#define __GT_DARandom__

#include "GT_API.h"
#include "GT_DataArray.h"

/// @brief An array of random values
///
/// This array has minimal storage and represents an array of random values.
/// @note The array has issues with more than 2^31 entries
class GT_API GT_DARandom : public GT_DataArray
{
public:
    /// @{ Constructors/Destructors
             GT_DARandom(GT_Size array_size, int tuple_size=1,
                        GT_Type tinfo=GT_TYPE_NONE,
                        uint seed=0, fpreal min=0, fpreal max=1);
             GT_DARandom(const GT_DARandom &src);
            ~GT_DARandom() override;
    /// @}

    /// @{
    /// Methods defined on GT_DataArray
    const char          *className() const override
                            { return "GT_DARandom"; }
    GT_Storage          getStorage() const override
                            { return GT_STORE_REAL32; }
    GT_Size             entries() const override
                            { return myEntries; }
    GT_Size             getTupleSize() const override
                            { return myTupleSize; }
    int64               getMemoryUsage() const override
                            { return sizeof(*this); }
    GT_Type             getTypeInfo() const override    { return myType; }
    
    fpreal32            getF32(GT_Offset offset, int idx) const override;
    uint8               getU8(GT_Offset offset, int idx) const override;
    int32               getI32(GT_Offset offset, int idx) const override;
    GT_String           getS(GT_Offset offset, int idx) const override;
    GT_Size             getStringIndexCount() const override
                            { return -1; }
    GT_Offset           getStringIndex(GT_Offset, int) const override
                            { return -1; }
    void                getIndexedStrings(UT_StringArray &,
                                          UT_IntArray &) const override {}
    GT_Size             getDictIndexCount() const override 
                            { return -1; }
    GT_Offset           getDictIndex(GT_Offset, int) const override 
                            { return -1; }
    void                getIndexedDicts(UT_Array<UT_OptionsHolder> &,
                                          UT_IntArray &) const override {}
    GT_DataArrayHandle  harden() const override
                            { return GT_DataArrayHandle(SYSconst_cast(this)); }
    /// @}

    /// The random numbers generated will be fit to this range.
    void        setRange(fpreal min=0, fpreal max=1)
                    { myMin = min; myMax = max; }

private:
    fpreal32    myMin, myMax;
    GT_Size     myEntries;
    int         myTupleSize;
    uint        mySeed;
    GT_Type     myType;
};

#endif