pluginbase.Helpers.Computative.Rand Class Reference

Convenience methods for random number generation More...

Static Public Member Functions
static float	Float ()
	Generate a random float between 0 inclusive and 1 exclusive More...
static float	Float (float max)
	Generate a random float between 0 inclusive and max exclusive More...
static float	Float (float min, float max)
	Generate a random float between min inclusive and max exclusive More...
static double	Double ()
	Generate a random double between 0 inclusive and 1 exclusive More...
static double	Double (double max)
	Generate a double between 0 inclusive and max exclusive More...
static double	Double (double min, double max)
	Generate a double between min inclusive and max exclusive More...
static int	Int ()
	Returns a random integer More...
static int	Int (int max)
	Returns a random integer less than max More...
static int	Int (int min, int max)
	Returns a random integer greater than min and less than max More...
static double	Unitd ()
	Returns a random double between 0.0 inclusive, and 1.0 exclusive More...
static float	Unitf ()
	Return a random float between 0.0 inclusive, and 1.0 exclusive More...
static double	Dird ()
	Return a double between -1 and 1 More...
static float	Dirf ()
	Return a float between -1 and 1 More...
static Vector3d	Dir3d ()
	Return a normalized random vector More...
static Vector3d	Dirz3d ()
	Return a normalized vector masked with (1,1,0) More...
static Vector3	Dir3f ()
	Return a normalized random vector More...
static Vector3	Dirz3f ()
	Return a normal vector masked with (1,1,0) More...
static Vector3	Vec3f (float min, float max)
	Create a vector where each component is between min and max More...
static Vector3d	Vec3d (double min, double max)
	Create a vector where each component is between min and max More...
static bool	Chance (double likelihood)
	Returns true if a random number falls below a likelihood More...
static T	PickRandom< T > (this IEnumerable< T > items)
	Pick an item randomly from a list More...
static T	PickRandom< T > (this IList< T > items)
	Pick an item randomly from a list More...
static T	PickRandomOrNull< T > (this IEnumerable< T > items)
	Pick an item randomly from a list More...
static T	PickRandomOrNull< T > (this IList< T > items)
	Pick an item randomly from a list More...

Detailed Description

Convenience methods for random number generation

Attribute: ThreadSafe

Member Function Documentation

Chance()

static bool pluginbase.Helpers.Computative.Rand.Chance ( double  likelihood )

static

Returns true if a random number falls below a likelihood

Parameters

likelihood

Likelihood.

        {
            return RandGen.NextDouble() < likelihood;
        }

Dir3d()

static Vector3d pluginbase.Helpers.Computative.Rand.Dir3d ( )

static

Return a normalized random vector

        {
            return new Vector3d(Dird(), Dird(), Dird()).Normalized();
        }

Dir3f()

static Vector3 pluginbase.Helpers.Computative.Rand.Dir3f ( )

static

Return a normalized random vector

        {
            return new Vector3(Dirf(), Dirf(), Dirf()).Normalized();
        }

Dird()

static double pluginbase.Helpers.Computative.Rand.Dird ( )

static

Return a double between -1 and 1

        {
            return RandGen.NextDouble() * 2.0 - 1.0;
        }

Dirf()

static float pluginbase.Helpers.Computative.Rand.Dirf ( )

static

Return a float between -1 and 1

        {
            return (float)RandGen.NextDouble() * 2f - 1f;
        }

Dirz3d()

static Vector3d pluginbase.Helpers.Computative.Rand.Dirz3d ( )

static

Return a normalized vector masked with (1,1,0)

        {
            return new Vector3d(Dird(), Dird(), 0.0).Normalized();
        }

Dirz3f()

static Vector3 pluginbase.Helpers.Computative.Rand.Dirz3f ( )

static

Return a normal vector masked with (1,1,0)

        {
            return new Vector3(Dirf(), Dirf(), 0f).Normalized();
        }

Double() [1/3]

static double pluginbase.Helpers.Computative.Rand.Double ( )

static

Generate a random double between 0 inclusive and 1 exclusive

        {
            return RandGen.NextDouble();
        }

Double() [2/3]

static double pluginbase.Helpers.Computative.Rand.Double ( double  max )

static

Generate a double between 0 inclusive and max exclusive

Parameters

max

Max.

        {
            return RandGen.NextDouble() * max;
        }

Double() [3/3]

static double pluginbase.Helpers.Computative.Rand.Double ( double  min, double  max  )

static

Generate a double between min inclusive and max exclusive

Parameters

min	Minimum.
max	Max.

        {
            return RandGen.NextDouble() * (max - min) + min;
        }

Float() [1/3]

static float pluginbase.Helpers.Computative.Rand.Float ( )

static

Generate a random float between 0 inclusive and 1 exclusive

        {
            return (float)RandGen.NextDouble();
        }

Float() [2/3]

static float pluginbase.Helpers.Computative.Rand.Float ( float  max )

static

Generate a random float between 0 inclusive and max exclusive

Parameters

max

Max.

        {
            return (float)RandGen.NextDouble() * max;
        }

Float() [3/3]

static float pluginbase.Helpers.Computative.Rand.Float ( float  min, float  max  )

static

Generate a random float between min inclusive and max exclusive

Parameters

min	Minimum.
max	Max.

        {
            return (float)RandGen.NextDouble() * (max - min) + min;
        }

Int() [1/3]

static int pluginbase.Helpers.Computative.Rand.Int ( )

static

Returns a random integer

        {
            return RandGen.Next();
        }

Int() [2/3]

static int pluginbase.Helpers.Computative.Rand.Int ( int  max )

static

Returns a random integer less than max

Parameters

max	The exclusive max value.

        {
            return RandGen.Next(max);
        }

Int() [3/3]

static int pluginbase.Helpers.Computative.Rand.Int ( int  min, int  max  )

static

Returns a random integer greater than min and less than max

Parameters

min	Inclusive minimum.
max	Exclusive max.

        {
            return RandGen.Next(min, max);
        }

PickRandom< T >() [1/2]

static T pluginbase.Helpers.Computative.Rand.PickRandom< T > ( this IEnumerable< T >  items )

static

Pick an item randomly from a list

Returns

The random.

Parameters

items

Items.

Template Parameters

T	The 1st type parameter.

Attribute: Rand.Int(arr.Length)

;

        {
            var arr = items.ToArray();
            if (arr.Length == 0)
                return default(T);
            return arr[Rand.Int(arr.Length)];
        }

PickRandom< T >() [2/2]

static T pluginbase.Helpers.Computative.Rand.PickRandom< T > ( this IList< T >  items )

static

Pick an item randomly from a list

Returns

The random.

Parameters

items

Items.

Template Parameters

T	The 1st type parameter.

Attribute: Rand.Int(items.Count)

;

        {
            if (items.Count == 0)
                return default(T);
            return items[Rand.Int(items.Count)];
        }

PickRandomOrNull< T >() [1/2]

static T pluginbase.Helpers.Computative.Rand.PickRandomOrNull< T > ( this IEnumerable< T >  items )

static

Pick an item randomly from a list

Returns

The random.

Parameters

items

Items.

Template Parameters

T	The 1st type parameter.

Attribute: Rand.Int(arr.Length)

;

Type Constraints

T

:

struct

                    : struct
        {
            var arr = items.ToArray();
            if (arr.Length == 0)
                return null;
            return arr[Rand.Int(arr.Length)];
        }

PickRandomOrNull< T >() [2/2]

static T pluginbase.Helpers.Computative.Rand.PickRandomOrNull< T > ( this IList< T >  items )

static

Pick an item randomly from a list

Returns

The random.

Parameters

items

Items.

Template Parameters

T	The 1st type parameter.

Attribute: Rand.Int(items.Count)

;

Type Constraints

T

:

struct

                    : struct
        {
            if (items.Count == 0)
                return null;
            return items[Rand.Int(items.Count)];
        }

Unitd()

static double pluginbase.Helpers.Computative.Rand.Unitd ( )

static

Returns a random double between 0.0 inclusive, and 1.0 exclusive

        {
            return RandGen.NextDouble();
        }

Unitf()

static float pluginbase.Helpers.Computative.Rand.Unitf ( )

static

Return a random float between 0.0 inclusive, and 1.0 exclusive

        {
            return (float)RandGen.NextDouble();
        }

Vec3d()

static Vector3d pluginbase.Helpers.Computative.Rand.Vec3d ( double  min, double  max  )

static

Create a vector where each component is between min and max

Returns

The vec3d.

Parameters

min	Minimum.
max	Max.

        {
            return new Vector3d(Double(min, max), Double(min, max), Double(min, max));
        }

Vec3f()

static Vector3 pluginbase.Helpers.Computative.Rand.Vec3f ( float  min, float  max  )

static

Create a vector where each component is between min and max

Returns

The vec3f.

Parameters

min	Minimum.
max	Max.

        {
            return new Vector3(Float(min, max), Float(min, max), Float(min, max));
        }

---

The documentation for this class was generated from the following file:

• pluginbase/Helpers/Computative/Rand.cs