A general-purpose range object, that simply represents any linear range with a start and end point. More...

#include <juce_Range.h>

Inheritance diagram for Range< ValueType >:

Collaboration diagram for Range< ValueType >:

Public Member Functions
	Range () noexcept
	Constructs an empty range. More...

	Range (const ValueType startValue, const ValueType endValue) noexcept
	Constructs a range with given start and end values. More...

	Range (const Range &other) noexcept
	Constructs a copy of another range. More...

ValueType	clipValue (const ValueType value) const noexcept
	Returns the nearest value to the one supplied, which lies within the range. More...

Range	constrainRange (Range rangeToConstrain) const noexcept
	Returns a given range, after moving it forwards or backwards to fit it within this range. More...

bool	contains (const ValueType position) const noexcept
	Returns true if the given position lies inside this range. More...

bool	contains (Range other) const noexcept
	Returns true if the given range lies entirely inside this range. More...

Range	expanded (ValueType amount) const noexcept
	Returns a range which has its start moved down and its end moved up by the given amount. More...

ValueType	getEnd () const noexcept
	Returns the end of the range. More...

Range	getIntersectionWith (Range other) const noexcept
	Returns the range that is the intersection of the two ranges, or an empty range with an undefined start position if they don't overlap. More...

ValueType	getLength () const noexcept
	Returns the length of the range. More...

ValueType	getStart () const noexcept
	Returns the start of the range. More...

Range	getUnionWith (Range other) const noexcept
	Returns the smallest range that contains both this one and the other one. More...

Range	getUnionWith (const ValueType valueToInclude) const noexcept
	Returns the smallest range that contains both this one and the given value. More...

bool	intersects (Range other) const noexcept
	Returns true if the given range intersects this one. More...

bool	isEmpty () const noexcept
	Returns true if the range has a length of zero. More...

Range	movedToEndAt (const ValueType newEnd) const noexcept
	Returns a range with the same length as this one, but moved to have the given end position. More...

Range	movedToStartAt (const ValueType newStart) const noexcept
	Returns a range with the same length as this one, but moved to have the given start position. More...

bool	operator!= (Range other) const noexcept

Range	operator+ (const ValueType amountToAdd) const noexcept
	Returns a range that is equal to this one with an amount added to its start and end. More...

Range	operator+= (const ValueType amountToAdd) noexcept
	Adds an amount to the start and end of the range. More...

Range	operator- (const ValueType amountToSubtract) const noexcept
	Returns a range that is equal to this one with the specified amount subtracted from its start and end. More...

Range	operator-= (const ValueType amountToSubtract) noexcept
	Subtracts an amount from the start and end of the range. More...

Range &	operator= (Range other) noexcept
	Copies another range object. More...

bool	operator== (Range other) const noexcept

void	setEnd (const ValueType newEnd) noexcept
	Changes the end position of the range, leaving the start unchanged. More...

void	setLength (const ValueType newLength) noexcept
	Changes the length of the range. More...

void	setStart (const ValueType newStart) noexcept
	Changes the start position of the range, leaving the end position unchanged. More...

Range	withEnd (const ValueType newEnd) const noexcept
	Returns a range with the same start position as this one, but a different end. More...

Range	withLength (const ValueType newLength) const noexcept
	Returns a range with the same start as this one, but a different length. More...

Range	withStart (const ValueType newStart) const noexcept
	Returns a range with the same end as this one, but a different start. More...

Static Public Member Functions
static Range	between (const ValueType position1, const ValueType position2) noexcept
	Returns the range that lies between two positions (in either order). More...

static Range	emptyRange (const ValueType start) noexcept
	Returns a range with the specified start position and a length of zero. More...

static Range	findMinAndMax (const ValueType *values, int numValues) noexcept
	Scans an array of values for its min and max, and returns these as a Range. More...

static Range	withStartAndLength (const ValueType startValue, const ValueType length) noexcept
	Returns a range with a given start and length. More...

Private Attributes
ValueType	end

ValueType	start

Detailed Description

template<typename ValueType>
class Range< ValueType >

A general-purpose range object, that simply represents any linear range with a start and end point.

Note that when checking whether values fall within the range, the start value is considered to be inclusive, and the end of the range exclusive.

The templated parameter is expected to be a primitive integer or floating point type, though class types could also be used if they behave in a number-like way.

Constructor & Destructor Documentation

◆ Range() [1/3]

template<typename ValueType>

Range< ValueType >::Range ( )

inlinenoexcept

Constructs an empty range.

Referenced by Range< int64 >::between(), Range< int64 >::emptyRange(), Range< int64 >::expanded(), Range< int64 >::findMinAndMax(), Range< int64 >::getIntersectionWith(), Range< int64 >::getUnionWith(), Range< int64 >::movedToEndAt(), Range< int64 >::movedToStartAt(), Range< int64 >::operator+(), Range< int64 >::operator-(), Range< int64 >::withEnd(), Range< int64 >::withLength(), Range< int64 >::withStart(), and Range< int64 >::withStartAndLength().

◆ Range() [2/3]

template<typename ValueType>

Range< ValueType >::Range	(	const ValueType	startValue,
		const ValueType	endValue
	)

inlinenoexcept

Constructs a range with given start and end values.

◆ Range() [3/3]

template<typename ValueType>

Range< ValueType >::Range ( const Range< ValueType > & other )

inlinenoexcept

Constructs a copy of another range.

Member Function Documentation

◆ between()

template<typename ValueType>

static Range Range< ValueType >::between	(	const ValueType	position1,
		const ValueType	position2
	)

inlinestaticnoexcept

Returns the range that lies between two positions (in either order).

◆ clipValue()

template<typename ValueType>

ValueType Range< ValueType >::clipValue ( const ValueType value ) const

inlinenoexcept

Returns the nearest value to the one supplied, which lies within the range.

Referenced by AnimatedPosition< Behaviour >::setPositionAndSendChange().

◆ constrainRange()

template<typename ValueType>

Range Range< ValueType >::constrainRange ( Range< ValueType > rangeToConstrain ) const

inlinenoexcept

Returns a given range, after moving it forwards or backwards to fit it within this range.

If the supplied range has a greater length than this one, the return value will be this range.

Otherwise, if the supplied range is smaller than this one, the return value will be the new range, shifted forwards or backwards so that it doesn't extend beyond this one, but keeping its original length.

◆ contains() [1/2]

template<typename ValueType>

bool Range< ValueType >::contains ( const ValueType position ) const

inlinenoexcept

Returns true if the given position lies inside this range.

When making this comparison, the start value is considered to be inclusive, and the end of the range exclusive.

◆ contains() [2/2]

template<typename ValueType>

bool Range< ValueType >::contains ( Range< ValueType > other ) const

inlinenoexcept

Returns true if the given range lies entirely inside this range.

◆ emptyRange()

template<typename ValueType>

static Range Range< ValueType >::emptyRange ( const ValueType start )

inlinestaticnoexcept

Returns a range with the specified start position and a length of zero.

◆ expanded()

template<typename ValueType>

Range Range< ValueType >::expanded ( ValueType amount ) const

inlinenoexcept

Returns a range which has its start moved down and its end moved up by the given amount.

Returns: The returned range will be (start - amount, end + amount)

◆ findMinAndMax()

template<typename ValueType>

static Range Range< ValueType >::findMinAndMax	(	const ValueType *	values,
		int	numValues
	)

inlinestaticnoexcept

Scans an array of values for its min and max, and returns these as a Range.

◆ getEnd()

template<typename ValueType>

ValueType Range< ValueType >::getEnd ( ) const

inlinenoexcept

Returns the end of the range.

Referenced by SparseSet< int >::addRange(), SparseSet< int >::containsRange(), AudioData::Pointer< SampleFormat, Endianness, InterleavingType, Constness >::findMinAndMax(), SparseSet< int >::overlapsRange(), and SparseSet< int >::removeRange().

◆ getIntersectionWith()

template<typename ValueType>

Range Range< ValueType >::getIntersectionWith ( Range< ValueType > other ) const

inlinenoexcept

Returns the range that is the intersection of the two ranges, or an empty range with an undefined start position if they don't overlap.

◆ getLength()

template<typename ValueType>

ValueType Range< ValueType >::getLength ( ) const

inlinenoexcept

Returns the length of the range.

Referenced by SparseSet< int >::addRange(), Range< int64 >::constrainRange(), SparseSet< int >::containsRange(), SparseSet< int >::overlapsRange(), and SparseSet< int >::removeRange().

◆ getStart()

template<typename ValueType>

ValueType Range< ValueType >::getStart ( ) const

inlinenoexcept

Returns the start of the range.

Referenced by SparseSet< int >::addRange(), SparseSet< int >::containsRange(), AudioData::Pointer< SampleFormat, Endianness, InterleavingType, Constness >::findMinAndMax(), SparseSet< int >::overlapsRange(), SparseSet< int >::removeRange(), and MemoryMappedAudioFormatReader::sampleToPointer().

◆ getUnionWith() [1/2]

template<typename ValueType>

Range Range< ValueType >::getUnionWith ( Range< ValueType > other ) const

inlinenoexcept

Returns the smallest range that contains both this one and the other one.

Referenced by AudioBlock< SampleType >::findMinAndMax().

◆ getUnionWith() [2/2]

template<typename ValueType>

Range Range< ValueType >::getUnionWith ( const ValueType valueToInclude ) const

inlinenoexcept

Returns the smallest range that contains both this one and the given value.

◆ intersects()

template<typename ValueType>

bool Range< ValueType >::intersects ( Range< ValueType > other ) const

inlinenoexcept

Returns true if the given range intersects this one.

◆ isEmpty()

template<typename ValueType>

bool Range< ValueType >::isEmpty ( ) const

inlinenoexcept

Returns true if the range has a length of zero.

◆ movedToEndAt()

template<typename ValueType>

Range Range< ValueType >::movedToEndAt ( const ValueType newEnd ) const

inlinenoexcept

Returns a range with the same length as this one, but moved to have the given end position.

◆ movedToStartAt()

template<typename ValueType>

Range Range< ValueType >::movedToStartAt ( const ValueType newStart ) const

inlinenoexcept

Returns a range with the same length as this one, but moved to have the given start position.

◆ operator!=()

template<typename ValueType>

bool Range< ValueType >::operator!= ( Range< ValueType > other ) const

inlinenoexcept

◆ operator+()

template<typename ValueType>

Range Range< ValueType >::operator+ ( const ValueType amountToAdd ) const

inlinenoexcept

Returns a range that is equal to this one with an amount added to its start and end.

◆ operator+=()

template<typename ValueType>

Range Range< ValueType >::operator+= ( const ValueType amountToAdd )

inlinenoexcept

Adds an amount to the start and end of the range.

◆ operator-()

template<typename ValueType>

Range Range< ValueType >::operator- ( const ValueType amountToSubtract ) const

inlinenoexcept

Returns a range that is equal to this one with the specified amount subtracted from its start and end.

◆ operator-=()

template<typename ValueType>

Range Range< ValueType >::operator-= ( const ValueType amountToSubtract )

inlinenoexcept

Subtracts an amount from the start and end of the range.

◆ operator=()

template<typename ValueType>

Range& Range< ValueType >::operator= ( Range< ValueType > other )

inlinenoexcept

Copies another range object.

◆ operator==()

template<typename ValueType>

bool Range< ValueType >::operator== ( Range< ValueType > other ) const

inlinenoexcept

◆ setEnd()

template<typename ValueType>

void Range< ValueType >::setEnd ( const ValueType newEnd )

inlinenoexcept

Changes the end position of the range, leaving the start unchanged.

If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

◆ setLength()

template<typename ValueType>

void Range< ValueType >::setLength ( const ValueType newLength )

inlinenoexcept

Changes the length of the range.

Lengths less than zero are treated as zero.

◆ setStart()

template<typename ValueType>

void Range< ValueType >::setStart ( const ValueType newStart )

inlinenoexcept

Changes the start position of the range, leaving the end position unchanged.

If the new start position is higher than the current end of the range, the end point will be pushed along to equal it, leaving an empty range at the new position.

◆ withEnd()

template<typename ValueType>

Range Range< ValueType >::withEnd ( const ValueType newEnd ) const

inlinenoexcept

Returns a range with the same start position as this one, but a different end.

If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

◆ withLength()

template<typename ValueType>

Range Range< ValueType >::withLength ( const ValueType newLength ) const

inlinenoexcept

Returns a range with the same start as this one, but a different length.

Lengths less than zero are treated as zero.

◆ withStart()

template<typename ValueType>

Range Range< ValueType >::withStart ( const ValueType newStart ) const

inlinenoexcept

Returns a range with the same end as this one, but a different start.

If the new start position is higher than the current end of the range, the end point will be pushed along to equal it, returning an empty range at the new position.

◆ withStartAndLength()

template<typename ValueType>

static Range Range< ValueType >::withStartAndLength	(	const ValueType	startValue,
		const ValueType	length
	)

inlinestaticnoexcept

Returns a range with a given start and length.

Referenced by Rectangle< ValueType >::getHorizontalRange(), and Rectangle< ValueType >::getVerticalRange().

Member Data Documentation

◆ end

template<typename ValueType>

ValueType Range< ValueType >::end

private

◆ start

template<typename ValueType>

ValueType Range< ValueType >::start

private

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

juce_Range.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<typename ValueType> class Range< ValueType >

Constructor & Destructor Documentation

◆ Range() [1/3]

◆ Range() [2/3]

◆ Range() [3/3]

Member Function Documentation

◆ between()

◆ clipValue()

◆ constrainRange()

◆ contains() [1/2]

◆ contains() [2/2]

◆ emptyRange()

◆ expanded()

◆ findMinAndMax()

◆ getEnd()

◆ getIntersectionWith()

◆ getLength()

◆ getStart()

◆ getUnionWith() [1/2]

◆ getUnionWith() [2/2]

◆ intersects()

◆ isEmpty()

◆ movedToEndAt()

◆ movedToStartAt()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator=()

◆ operator==()

◆ setEnd()

◆ setLength()

◆ setStart()

◆ withEnd()

◆ withLength()

◆ withStart()

◆ withStartAndLength()

Member Data Documentation

◆ end

◆ start

template<typename ValueType>
class Range< ValueType >