ILIAS\Data\Interval\ClosedFloatInterval Class Reference

Collaboration diagram for ILIAS\Data\Interval\ClosedFloatInterval:

Public Member Functions
	__construct ($minimum, $maximum)
	spans (float $numberToCheck)
	minimum ()
	maximum ()

Private Attributes
	$range

Detailed Description

Definition at line 13 of file ClosedFloatInterval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Interval\ClosedFloatInterval::__construct	(		$minimum,
			$maximum
	)

Parameters

$minimum
$maximum

Exceptions

ConstraintViolationException

Definition at line 25 of file ClosedFloatInterval.php.

    {
        if ($maximum === $minimum) {
            throw new ConstraintViolationException(
                sprintf('The maximum("%s") and minimum("%s") can NOT be the same', $maximum, $minimum),
                'exception_maximum_minimum_same',
                $maximum,
                $minimum
            );
        }

        $this->range = new OpenedFloatInterval($minimum, $maximum);
    }

Member Function Documentation

maximum()

ILIAS\Data\Interval\ClosedFloatInterval::maximum

(

)

Returns

float

Definition at line 65 of file ClosedFloatInterval.php.

                              : float
    {
        return $this->range->maximum();
    }

minimum()

ILIAS\Data\Interval\ClosedFloatInterval::minimum

(

)

Returns

float

Definition at line 57 of file ClosedFloatInterval.php.

                              : float
    {
        return $this->range->minimum();
    }

spans()

ILIAS\Data\Interval\ClosedFloatInterval::spans

(

float

$numberToCheck

)

Parameters

float

$numberToCheck

Returns

bool

Definition at line 43 of file ClosedFloatInterval.php.

                                                : bool
    {
        if ($numberToCheck <= $this->range->minimum()) {
            return false;
        } elseif ($numberToCheck >= $this->range->maximum()) {
            return false;
        }

        return true;
    }

Field Documentation

$range

ILIAS\Data\Interval\ClosedFloatInterval::$range

private

Definition at line 18 of file ClosedFloatInterval.php.

---

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

• src/Data/Interval/ClosedFloatInterval.php