AuroraRuntime/Include/Aurora/RNG/IRandomDevice.hpp

  /***
    Copyright (C) 2021 J Reece Wilson (a/k/a "Reece"). All rights reserved.

    File: IRandomDevice.hpp
    Date: 2021-9-3
    Author: Reece
***/
#pragma once 

namespace Aurora::RNG
{
    static const auto kSizeRNGDevice = 256;

    struct IRandomDevice
    {
        virtual void                Read(Memory::MemoryViewWrite view) = 0;

        virtual AuString            NextString(AuUInt32 uLength, ERngStringCharacters type = ERngStringCharacters::eAlphaCharacters) = 0;
        virtual void                NextString(char *pString, AuUInt32 uLength, ERngStringCharacters type = ERngStringCharacters::eAlphaCharacters) = 0;
        virtual AuUInt8             NextByte() = 0;
        virtual bool                NextBoolean() = 0;
        virtual AuUInt32            NextU32() = 0;
        virtual AuUInt32            NextU32Range(AuUInt32 uMin, AuUInt32 uMax) = 0;
        virtual AuInt32             NextI32Range(AuInt32 iMin, AuInt32 iMax) = 0;
        virtual AuUInt64            NextU64() = 0;
        virtual AuUInt64            NextU64Range(AuUInt64 uMin, AuUInt64 uMax) = 0;
        virtual AuInt64             NextI64Range(AuInt64 iMin, AuInt64 iMax) = 0;
        virtual AuVec2              NextVec2(AuVec2 boundA, AuVec2 boundB) = 0;
        virtual AuVec2              NextVec2Sorted(AuVec2 min, AuVec2 max) = 0;
        virtual AuVec3              NextVec3(AuVec3 boundA, AuVec3 boundB) = 0;
        virtual AuVec3              NextVec3Sorted(AuVec3 min, AuVec3 max) = 0;
        virtual AuVec4              NextVec4(AuVec4 boundA, AuVec4 boundB) = 0;
        virtual AuVec4              NextVec4Sorted(AuVec4 min, AuVec4 max) = 0;
        virtual double              NextDecimal() = 0;
        virtual double              NextNumber(double dMin, double dMax) = 0;
        virtual AuUInt32            NextIndex(AuUInt32 uCount /* = max + 1*/) = 0;
        virtual uuids::uuid         NextUUID() = 0;
        virtual AuList<AuInt32>     NextArrayI32Range(AuUInt32 uCount, AuInt32 iMin, AuInt32 iMax) = 0;
        virtual AuList<AuInt32>     NextArrayI32RangeFast(AuUInt32 uCount, AuInt32 iMin, AuInt32 iMax) = 0;
        virtual AuList<AuUInt32>    NextArrayU32Range(AuUInt32 uCount, AuUInt32 uMin, AuUInt32 uMax) = 0;
        virtual AuList<AuUInt32>    NextArrayU32RangeFast(AuUInt32 uCount, AuUInt32 uMin, AuUInt32 uMax) = 0;
        virtual AuList<AuInt64>     NextArrayI64Range(AuUInt32 uCount, AuInt64 iMin, AuInt64 iMax) = 0;
        virtual AuList<AuInt64>     NextArrayI64RangeFast(AuUInt32 uCount, AuInt64 iMin, AuInt64 iMax) = 0;
        virtual AuList<AuUInt64>    NextArrayU64Range(AuUInt32 uCount, AuUInt64 uMin, AuUInt64 uMax) = 0;
        virtual AuList<AuUInt64>    NextArrayU64RangeFast(AuUInt32 uCount, AuUInt64 uMin, AuUInt64 uMax) = 0;
        virtual AuList<AuUInt32>    NextArrayU32Mask(AuUInt32 uCount, AuUInt32 uMask) = 0;
        virtual AuList<AuUInt64>    NextArrayU64Mask(AuUInt32 uCount, AuUInt64 uMask) = 0;
        virtual AuList<double>      NextArrayDoubleRange(AuUInt32 uCount, double dMin, double dMax) = 0;
        virtual AuList<double>      NextArrayDoubleRangeFast(AuUInt32 uCount, double dMin, double dMax) = 0;
        virtual AuList<AuInt32>     NextArrayI32(AuUInt32 uCount) = 0;
        virtual AuList<AuUInt32>    NextArrayU32(AuUInt32 uCount) = 0;
        virtual AuList<AuInt64>     NextArrayI64(AuUInt32 uCount) = 0;
        virtual AuList<AuUInt64>    NextArrayU64(AuUInt32 uCount) = 0;
        virtual AuList<AuVec2>      NextArrayVec2(AuUInt32 uCount, AuVec2 boundA, AuVec2 boundB) = 0;
        virtual AuList<AuVec2>      NextArrayVec2Fast(AuUInt32 uCount, AuVec2 boundA, AuVec2 boundB) = 0;
        virtual AuList<AuVec2>      NextArrayVec2Sorted(AuUInt32 uCount, AuVec2 min, AuVec2 max) = 0;
        virtual AuList<AuVec2>      NextArrayVec2SortedFast(AuUInt32 uCount, AuVec2 min, AuVec2 max) = 0;
        virtual AuList<AuVec3>      NextArrayVec3(AuUInt32 uCount, AuVec3 boundA, AuVec3 boundB) = 0;
        virtual AuList<AuVec3>      NextArrayVec3Fast(AuUInt32 uCount, AuVec3 boundA, AuVec3 boundB) = 0;
        virtual AuList<AuVec3>      NextArrayVec3Sorted(AuUInt32 uCount, AuVec3 min, AuVec3 max) = 0;
        virtual AuList<AuVec3>      NextArrayVec3SortedFast(AuUInt32 uCount, AuVec3 min, AuVec3 max) = 0;
        virtual AuList<AuVec4>      NextArrayVec4(AuUInt32 uCount, AuVec4 boundA, AuVec4 boundB) = 0;
        virtual AuList<AuVec4>      NextArrayVec4Fast(AuUInt32 uCount, AuVec4 boundA, AuVec4 boundB) = 0;
        virtual AuList<AuVec4>      NextArrayVec4Sorted(AuUInt32 uCount, AuVec4 min, AuVec4 max) = 0;
        virtual AuList<AuVec4>      NextArrayVec4SortedFast(AuUInt32 uCount, AuVec4 min, AuVec4 max) = 0;
        virtual AuList<double>      NextArrayDouble(AuUInt32 uCount) = 0;
        virtual AuList<double>      NextArrayDecimals(AuUInt32 uCount) = 0;
        virtual AuList<double>      NextArrayDecimalsFast(AuUInt32 uCount) = 0;
        virtual AuList<uuids::uuid> NextArrayUUIDs(AuUInt32 uCount) = 0;

        virtual IO::IStreamReader *ToStreamReader() = 0;
        virtual Memory::MemoryViewRead ToSeed() = 0;
    
        template<typename T, int N>
        inline void NextFillArray(T(&array)[N])
        {
            Read(Memory::MemoryViewWrite(array));
        }

        template<typename T>
        inline void NextFillArray(T *pArray, AuUInt32 uCount)
        {
            Read(Memory::MemoryViewWrite(pArray, uCount * sizeof(T)));
        }

        template<typename T>
        void NextFillRange(T &container)
        {
            NextFillArray(container.begin(), container.end() - container.begin());
        }

        inline void NextFillBuffer(Memory::ByteBuffer &buffer)
        {
            auto view = buffer.GetNextLinearWrite();
            NextFillRange(view);
            buffer.writePtr += view.length;
        }

        /**
         * @brief
         * @deprecated
        */
        inline void NextFillRange(Memory::ByteBuffer &buffer)
        {
            NextFillBuffer(buffer);
        }
    
        template<typename T>
        inline T NextFillTmpl()
        {
            T ret {};
            Read(Memory::MemoryViewWrite(&ret, sizeof(T)));
            return ret;
        }

        template<typename T>
        inline T NextIterator(T begin, T end)
        {
            auto nextItr = begin;
            auto uCount = std::distance(begin, end);
            std::advance(nextItr, NextIndex(uCount));
            return nextItr;
        }

        template<typename T>
        inline T &NextArray(T *pItems, AuUInt32 uCount)
        {
            return pItems[NextIndex(uCount)];
        }

        template<typename T>
        inline auto NextRange(T &items)
        {
            return NextIterator(items.begin(), items.end());
        }

        template<typename T>
        inline T &NextList(AuList<T> &items)
        {
            return *NextRange(items);
        }

        template<typename T>
        inline const T &NextList(const AuList<T> &items)
        {
            return *NextRange(items);
        }

        template<typename T>
        inline void ShuffleIterators(T begin, T end)
        {
            AU_DEBUG_MEMCRUNCH;

            auto uCount = std::distance(begin, end);
            auto nextIndexArray = this->NextArrayU32RangeFast(uCount, 0, uCount - 1);
            
            for (AU_ITERATE_N(i, AuUInt(uCount)))
            {
                auto nextItrA = begin;
                auto nextItrB = begin;
                std::advance(nextItrA, i);
                std::advance(nextItrB, nextIndexArray[i]);
                AuSwap(*nextItrA, *nextItrB);
            }
        }

        template<typename T>
        inline void ShuffleList(AuList<T> &list)
        {
            this->ShuffleIterators(list.begin(), list.end());
        }
    };

    AUKN_SHARED_SOO2(Random, IRandomDevice, kSizeRNGDevice,
                     ((const RandomDef &, def)),
                     const RandomDef &def);
}