Hedgehog


Range Module

Namespace: Hedgehog

Assembly: Hedgehog.dll

Nested modules

Modules Description

Internal

Functions and values

Function or value Description

bounds sz arg2

Full Usage: bounds sz arg2

Parameters:
Returns: 'a * 'a

Get the extents of a range, for a given size.

sz : Size
arg1 : Range<'a>
Returns: 'a * 'a

constant lowerBound upperBound

Full Usage: constant lowerBound upperBound

Parameters:
    lowerBound : 'a
    upperBound : 'a

Returns: Range<'a>

Construct a range which is unaffected by the size parameter.

lowerBound : 'a
upperBound : 'a
Returns: Range<'a>

constantBounded ()

Full Usage: constantBounded ()

Parameters:
    () : unit

Returns: Range<^a>

Construct a range which is unaffected by the size parameter using the full range of a data type.

() : unit
Returns: Range<^a>

constantFrom origin lowerBound upperBound

Full Usage: constantFrom origin lowerBound upperBound

Parameters:
    origin : 'a
    lowerBound : 'a
    upperBound : 'a

Returns: Range<'a>

Construct a range which is unaffected by the size parameter with a origin point which may differ from the bounds.

origin : 'a
lowerBound : 'a
upperBound : 'a
Returns: Range<'a>

exponential lowerBound upperBound

Full Usage: exponential lowerBound upperBound

Parameters:
    lowerBound : ^a
    upperBound : ^a

Returns: Range<^a>

Construct a range which scales the second bound exponentially relative to the size parameter.

lowerBound : ^a
upperBound : ^a
Returns: Range<^a>

exponentialBounded ()

Full Usage: exponentialBounded ()

Parameters:
    () : unit

Returns: Range<^a>

Construct a range which is scaled exponentially relative to the size parameter and uses the full range of a data type.

() : unit
Returns: Range<^a>

exponentialFrom origin lowerBound upperBound

Full Usage: exponentialFrom origin lowerBound upperBound

Parameters:
    origin : ^a
    lowerBound : ^a
    upperBound : ^a

Returns: Range<^a>

Construct a range which scales the bounds exponentially relative to the size parameter.

origin : ^a
lowerBound : ^a
upperBound : ^a
Returns: Range<^a>

linear lowerBound upperBound

Full Usage: linear lowerBound upperBound

Parameters:
    lowerBound : ^a
    upperBound : ^a

Returns: Range<^a>

Construct a range which scales the second bound relative to the size parameter.

lowerBound : ^a
upperBound : ^a
Returns: Range<^a>

linearBounded ()

Full Usage: linearBounded ()

Parameters:
    () : unit

Returns: Range<^a>

Construct a range which is scaled relative to the size parameter and uses the full range of a data type.

() : unit
Returns: Range<^a>

linearFrom origin lowerBound upperBound

Full Usage: linearFrom origin lowerBound upperBound

Parameters:
    origin : ^a
    lowerBound : ^a
    upperBound : ^a

Returns: Range<^a>

Construct a range which scales the bounds relative to the size parameter.

origin : ^a
lowerBound : ^a
upperBound : ^a
Returns: Range<^a>

lowerBound sz range

Full Usage: lowerBound sz range

Parameters:
Returns: 'a

Get the lower bound of a range for the given size.

sz : Size
range : Range<'a>
Returns: 'a

map f arg2

Full Usage: map f arg2

Parameters:
    f : 'a -> 'b
    arg1 : Range<'a>

Returns: Range<'b>

Map a modification function over a Range.

f : 'a -> 'b
arg1 : Range<'a>
Returns: Range<'b>

origin arg1

Full Usage: origin arg1

Parameters:
Returns: 'a

Get the origin of a range. This might be the mid-point or the lower bound, depending on what the range represents. The 'bounds' of a range are scaled around this value when using the 'linear' family of combinators. When using a 'Range' to generate numbers, the shrinking function will shrink towards the origin.

arg0 : Range<'a>
Returns: 'a

singleton x

Full Usage: singleton x

Parameters:
    x : 'a

Returns: Range<'a>

Construct a range which represents a constant single value.

x : 'a
Returns: Range<'a>

upperBound sz range

Full Usage: upperBound sz range

Parameters:
Returns: 'a

Get the upper bound of a range for the given size.

sz : Size
range : Range<'a>
Returns: 'a