System::Random Class Reference

Inherits System::Object.

Public Member Functions

bool IsNull () const
 Always returns false. More...
 
ASPOSECPP_SHARED_API Random ()
 Initializes a new instance, using a time-dependent default seed value. More...
 
ASPOSECPP_SHARED_API Random (int32_t seed)
 
virtual ASPOSECPP_SHARED_API int32_t Next ()
 Returns a nonnegative random number less then int32 max value. More...
 
virtual ASPOSECPP_SHARED_API int32_t Next (int32_t maxValue)
 
virtual ASPOSECPP_SHARED_API int32_t Next (int32_t minValue, int32_t maxValue)
 
virtual ASPOSECPP_SHARED_API void NextBytes (const ArrayPtr< uint8_t > &buffer)
 
virtual ASPOSECPP_SHARED_API double NextDouble ()
 Returns a random number between 0.0 and 1.0. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a pseudo-random number generator. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

#include "system/random.h"
#include "system/smart_ptr.h"
#include <iostream>
int main()
{
const auto rnd = System::MakeObject<System::Random>();
// Get a random month number and print it.
auto monthNumber = rnd->Next(1, 13);
std::cout << "Month: " << monthNumber << std::endl;
// Fill the array with random numbers.
auto arr = System::MakeObject<System::Array<uint8_t>>(12);
rnd->NextBytes(arr);
// Print the array.
for (auto i = 0; i < arr->get_Length(); ++i)
{
std::cout << static_cast<int>(arr[i]) << ' ';
}
std::cout << std::endl;
return 0;
}
/*
* This code example produces the following output:
* Month: 4
* 177 213 89 240 68 182 18 96 109 131 1 78
*/

Constructor & Destructor Documentation

◆ Random() [1/2]

ASPOSECPP_SHARED_API System::Random::Random ( )

Initializes a new instance, using a time-dependent default seed value.

◆ Random() [2/2]

ASPOSECPP_SHARED_API System::Random::Random ( int32_t  seed)

Initializes a new instance of the System.Random class, using the specified seed value.

Parameters
seedThe seed used to generate a pseudo-random number sequence

Member Function Documentation

◆ IsNull()

bool System::Random::IsNull ( ) const
inline

Always returns false.

◆ Next() [1/3]

virtual ASPOSECPP_SHARED_API int32_t System::Random::Next ( )
virtual

Returns a nonnegative random number less then int32 max value.

◆ Next() [2/3]

virtual ASPOSECPP_SHARED_API int32_t System::Random::Next ( int32_t  maxValue)
virtual

Returns a nonnegative random number less than the specified maximum.

Parameters
maxValueValues generated by the method will be less than this value

◆ Next() [3/3]

virtual ASPOSECPP_SHARED_API int32_t System::Random::Next ( int32_t  minValue,
int32_t  maxValue 
)
virtual

Returns a random number within the specified range.

Parameters
minValueValues generated by the method will be greater than this value
maxValueValues generated by the method will be less than this value

◆ NextBytes()

virtual ASPOSECPP_SHARED_API void System::Random::NextBytes ( const ArrayPtr< uint8_t > &  buffer)
virtual

Fills the elements of the specified array of bytes with random numbers.

Parameters
bufferThe array to fill

◆ NextDouble()

virtual ASPOSECPP_SHARED_API double System::Random::NextDouble ( )
virtual

Returns a random number between 0.0 and 1.0.