Holds a set of primitive values, storing them as a set of ranges. More...

#include <juce_SparseSet.h>

Inheritance diagram for juce::SparseSet< Type >:

Collaboration diagram for juce::SparseSet< Type >:

[legend]

Public Member Functions
	SparseSet ()=default

	SparseSet (const SparseSet &)=default

	SparseSet (SparseSet &&other) noexcept

void	addRange (Range< Type > range)
	Adds a range of contiguous values to the set.

void	clear ()
	Clears the set.

bool	contains (Type valueToLookFor) const noexcept
	Checks whether a particular value is in the set.

bool	containsRange (Range< Type > range) const noexcept
	Checks whether the whole of a given range is contained within this one.

int	getNumRanges () const noexcept
	Returns the number of contiguous blocks of values.

Range< Type >	getRange (int rangeIndex) const noexcept
	Returns one of the contiguous ranges of values stored.

const Array< Range< Type > > &	getRanges () const noexcept
	Returns the set as a list of ranges, which you may want to iterate over.

Range< Type >	getTotalRange () const noexcept
	Returns the range between the lowest and highest values in the set.

void	invertRange (Range< Type > range)
	Does an XOR of the values in a given range.

bool	isEmpty () const noexcept
	Checks whether the set is empty.

bool	operator!= (const SparseSet &other) const noexcept

SparseSet &	operator= (const SparseSet &)=default

SparseSet &	operator= (SparseSet &&other) noexcept

bool	operator== (const SparseSet &other) const noexcept

Type	operator[] (Type index) const noexcept
	Returns one of the values in the set.

bool	overlapsRange (Range< Type > range) const noexcept
	Checks whether any part of a given range overlaps any part of this set.

void	removeRange (Range< Type > rangeToRemove)
	Removes a range of values from the set.

Type	size () const noexcept
	Returns the number of values in the set.

Private Member Functions
void	simplify ()

Private Attributes
Array< Range< Type > >	ranges

Detailed Description

template<class Type>
class juce::SparseSet< Type >

Holds a set of primitive values, storing them as a set of ranges.

This container acts like an array, but can efficiently hold large contiguous ranges of values. It's quite a specialised class, mostly useful for things like keeping the set of selected rows in a listbox.

The type used as a template parameter must be an integer type, such as int, short, int64, etc.

@tags{Core}

Constructor & Destructor Documentation

◆ SparseSet() [1/3]

template<class Type >

juce::SparseSet< Type >::SparseSet ( )

default

◆ SparseSet() [2/3]

template<class Type >

juce::SparseSet< Type >::SparseSet ( const SparseSet< Type > & )

default

◆ SparseSet() [3/3]

template<class Type >

juce::SparseSet< Type >::SparseSet ( SparseSet< Type > && other )

inlinenoexcept

Member Function Documentation

◆ addRange()

template<class Type >

void juce::SparseSet< Type >::addRange ( Range< Type > range )

inline

Adds a range of contiguous values to the set.

e.g. addRange (Range <int> (10, 14)) will add (10, 11, 12, 13) to the set.

References juce::SparseSet< Type >::ranges, juce::SparseSet< Type >::removeRange(), and juce::SparseSet< Type >::simplify().

Referenced by juce::SparseSet< Type >::invertRange().

◆ clear()

template<class Type >

void juce::SparseSet< Type >::clear ( )

inline

Clears the set.

References juce::SparseSet< Type >::ranges.

◆ contains()

template<class Type >

bool juce::SparseSet< Type >::contains ( Type valueToLookFor ) const

inlinenoexcept

Checks whether a particular value is in the set.

References juce::SparseSet< Type >::ranges.

◆ containsRange()

template<class Type >

bool juce::SparseSet< Type >::containsRange ( Range< Type > range ) const

inlinenoexcept

Checks whether the whole of a given range is contained within this one.

References juce::SparseSet< Type >::ranges.

◆ getNumRanges()

template<class Type >

int juce::SparseSet< Type >::getNumRanges ( ) const

inlinenoexcept

Returns the number of contiguous blocks of values.

See also: getRange

References juce::SparseSet< Type >::ranges.

◆ getRange()

template<class Type >

Range< Type > juce::SparseSet< Type >::getRange ( int rangeIndex ) const

inlinenoexcept

Returns one of the contiguous ranges of values stored.

Parameters

rangeIndex the index of the range to look up, between 0 and (getNumRanges() - 1)

See also: getTotalRange

References juce::SparseSet< Type >::ranges.

◆ getRanges()

template<class Type >

const Array< Range< Type > > & juce::SparseSet< Type >::getRanges ( ) const

inlinenoexcept

Returns the set as a list of ranges, which you may want to iterate over.

References juce::SparseSet< Type >::ranges.

◆ getTotalRange()

template<class Type >

Range< Type > juce::SparseSet< Type >::getTotalRange ( ) const

inlinenoexcept

Returns the range between the lowest and highest values in the set.

See also: getRange

References juce::Range< ValueType >::getStart(), and juce::SparseSet< Type >::ranges.

Referenced by juce::SparseSet< Type >::removeRange().

◆ invertRange()

template<class Type >

void juce::SparseSet< Type >::invertRange ( Range< Type > range )

inline

Does an XOR of the values in a given range.

References juce::SparseSet< Type >::addRange(), juce::SparseSet< Type >::ranges, and juce::SparseSet< Type >::removeRange().

◆ isEmpty()

template<class Type >

bool juce::SparseSet< Type >::isEmpty ( ) const

inlinenoexcept

Checks whether the set is empty.

This is much quicker than using (size() == 0).

References juce::SparseSet< Type >::ranges.

◆ operator!=()

template<class Type >

bool juce::SparseSet< Type >::operator!= ( const SparseSet< Type > & other ) const

inlinenoexcept

References juce::SparseSet< Type >::ranges.

◆ operator=() [1/2]

template<class Type >

SparseSet & juce::SparseSet< Type >::operator= ( const SparseSet< Type > & )

default

◆ operator=() [2/2]

template<class Type >

SparseSet & juce::SparseSet< Type >::operator= ( SparseSet< Type > && other )

inlinenoexcept

References juce::SparseSet< Type >::ranges.

◆ operator==()

template<class Type >

bool juce::SparseSet< Type >::operator== ( const SparseSet< Type > & other ) const

inlinenoexcept

References juce::SparseSet< Type >::ranges.

◆ operator[]()

template<class Type >

Type juce::SparseSet< Type >::operator[] ( Type index ) const

inlinenoexcept

Returns one of the values in the set.

Parameters

index the index of the value to retrieve, in the range 0 to (size() - 1).

Returns: the value at this index, or 0 if it's out-of-range

References juce::end(), and juce::SparseSet< Type >::ranges.

◆ overlapsRange()

template<class Type >

bool juce::SparseSet< Type >::overlapsRange ( Range< Type > range ) const

inlinenoexcept

Checks whether any part of a given range overlaps any part of this set.

References juce::SparseSet< Type >::ranges.

◆ removeRange()

template<class Type >

void juce::SparseSet< Type >::removeRange ( Range< Type > rangeToRemove )

inline

Removes a range of values from the set.

e.g. removeRange (Range<int> (10, 14)) will remove (10, 11, 12, 13) from the set.

References juce::Range< ValueType >::contains(), juce::Range< ValueType >::getEnd(), juce::Range< ValueType >::getStart(), juce::SparseSet< Type >::getTotalRange(), juce::Range< ValueType >::isEmpty(), jassert, and juce::SparseSet< Type >::ranges.

Referenced by juce::SparseSet< Type >::addRange(), and juce::SparseSet< Type >::invertRange().

◆ simplify()

template<class Type >

void juce::SparseSet< Type >::simplify ( )

inlineprivate

References juce::SparseSet< Type >::ranges.

Referenced by juce::SparseSet< Type >::addRange().

◆ size()

template<class Type >

Type juce::SparseSet< Type >::size ( ) const

inlinenoexcept

Returns the number of values in the set.

Because of the way the data is stored, this method can take longer if there are a lot of items in the set. Use isEmpty() for a quick test of whether there are any items.

References juce::SparseSet< Type >::ranges.

Member Data Documentation

◆ ranges

template<class Type >

Array<Range<Type> > juce::SparseSet< Type >::ranges

private

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

juce_SparseSet.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SparseSet() [1/3]

◆ SparseSet() [2/3]

◆ SparseSet() [3/3]

Member Function Documentation

◆ addRange()

◆ clear()

◆ contains()

◆ containsRange()

◆ getNumRanges()

◆ getRange()

◆ getRanges()

◆ getTotalRange()

◆ invertRange()

◆ isEmpty()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ overlapsRange()

◆ removeRange()

◆ simplify()

◆ size()

Member Data Documentation

◆ ranges