net.jqwik.api.arbitraries

Interface FloatArbitrary

All Superinterfaces:

Arbitrary<java.lang.Float>, NumericalArbitrary<java.lang.Float,FloatArbitrary>

@API(status=MAINTAINED,
     since="1.0")
public interface FloatArbitrary
extends NumericalArbitrary<java.lang.Float,FloatArbitrary>

Fluent interface to configure the generation of Float and float values.

Nested Class Summary

Nested classes/interfaces inherited from interface net.jqwik.api.Arbitrary

Arbitrary.ArbitraryFacade

Method Summary

Modifier and Type	Method and Description
FloatArbitrary	between(float min, boolean minIncluded, float max, boolean maxIncluded) Set the allowed lower min (included) and upper max (included) border of generated numbers.
default FloatArbitrary	between(float min, float max) Set the allowed lower min (included) and upper max (included) border of generated numbers.
FloatArbitrary	greaterOrEqual(float min) Set the allowed lower min (included) border of generated numbers.
FloatArbitrary	greaterThan(float min) Set the allowed lower min (excluded) border of generated numbers.
FloatArbitrary	lessOrEqual(float max) Set the allowed upper max (included) border of generated numbers.
FloatArbitrary	lessThan(float max) Set the allowed upper max (excluded) border of generated numbers.
FloatArbitrary	ofScale(int scale) Set the scale (maximum number of decimal places) to scale.
FloatArbitrary	shrinkTowards(float target) Set shrinking target to target which must be between the allowed bounds.
FloatArbitrary	withSpecialValue(float special) Inject a special value into generated values and edge cases.
FloatArbitrary	withStandardSpecialValues() Inject a selection of special values using withSpecialValue(float): Float.NaN Float.MIN_VALUE Float.MIN_NORMAL Float.POSITIVE_INFINITY Float.NEGATIVE_INFINITY This value can be outside the constraints of the arbitrary, e.g. have more decimals than specified by ofScale(int).

Methods inherited from interface net.jqwik.api.arbitraries.NumericalArbitrary

withDistribution

Methods inherited from interface net.jqwik.api.Arbitrary

allValues, array, asGeneric, collect, dontShrink, edgeCases, edgeCases, edgeCases, exhaustive, exhaustive, filter, filter, fixGenSize, flatMap, forEachValue, generator, generator, generatorWithEmbeddedEdgeCases, ignoreException, ignoreException, ignoreExceptions, ignoreExceptions, injectDuplicates, injectNull, isGeneratorMemoizable, iterator, list, map, optional, optional, sample, sampleStream, set, stream, tuple1, tuple2, tuple3, tuple4, tuple5, withoutEdgeCases

Method Detail

between

default FloatArbitrary between(float min,
                               float max)

Set the allowed lower min (included) and upper max (included) border of generated numbers.

Parameters:

min - The lower border of possible values

max - The upper border of possible values

between

FloatArbitrary between(float min,
                       boolean minIncluded,
                       float max,
                       boolean maxIncluded)

Set the allowed lower min (included) and upper max (included) border of generated numbers. Specify if borders should be included in allowed values or not.

Parameters:

min - The lower border of possible values

minIncluded - Should the lower border be included

max - The upper border of possible values

maxIncluded - Should the upper border be included

greaterOrEqual

FloatArbitrary greaterOrEqual(float min)

Set the allowed lower min (included) border of generated numbers.

Parameters:

min - The lower border of possible values

greaterThan

@API(status=MAINTAINED,
     since="1.2.7")
FloatArbitrary greaterThan(float min)

Set the allowed lower min (excluded) border of generated numbers.

Parameters:

min - The lower border of possible values

lessOrEqual

FloatArbitrary lessOrEqual(float max)

Set the allowed upper max (included) border of generated numbers.

Parameters:

max - The upper border of possible values

lessThan

@API(status=MAINTAINED,
     since="1.2.7")
FloatArbitrary lessThan(float max)

Set the allowed upper max (excluded) border of generated numbers.

Parameters:

max - The upper border of possible values

ofScale

FloatArbitrary ofScale(int scale)

Set the scale (maximum number of decimal places) to scale.

shrinkTowards

@API(status=MAINTAINED,
     since="1.4.0")
FloatArbitrary shrinkTowards(float target)

Set shrinking target to target which must be between the allowed bounds.

withSpecialValue

@API(status=EXPERIMENTAL,
     since="1.5.4")
FloatArbitrary withSpecialValue(float special)

Inject a special value into generated values and edge cases. This value can be outside the constraints of the arbitrary, e.g. have more decimals than specified by ofScale(int).

Parameters:

special - value

Returns:

new instance of arbitrary

withStandardSpecialValues

@API(status=EXPERIMENTAL,
     since="1.5.4")
FloatArbitrary withStandardSpecialValues()

Inject a selection of special values using withSpecialValue(float):

• Float.NaN
• Float.MIN_VALUE
• Float.MIN_NORMAL
• Float.POSITIVE_INFINITY
• Float.NEGATIVE_INFINITY

This value can be outside the constraints of the arbitrary, e.g. have more decimals than specified by ofScale(int).

Returns:

new instance of arbitrary