openshot-audio  0.1.6
Public Member Functions | List of all members
juce::SparseSet< Type > Class Template Reference

#include <juce_core.h>

Public Member Functions

 SparseSet ()
 
 SparseSet (const SparseSet< Type > &other)
 
void clear ()
 
bool isEmpty () const noexcept
 
Type size () const
 
Type operator[] (Type index) const
 
bool contains (const Type valueToLookFor) const
 
int getNumRanges () const noexcept
 
const Range< Type > getRange (const int rangeIndex) const
 
Range< Type > getTotalRange () const
 
void addRange (const Range< Type > range)
 
void removeRange (const Range< Type > rangeToRemove)
 
void invertRange (const Range< Type > range)
 
bool overlapsRange (const Range< Type > range)
 
bool containsRange (const Range< Type > range)
 
bool operator== (const SparseSet< Type > &other) noexcept
 
bool operator!= (const SparseSet< Type > &other) noexcept
 

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.

Constructor & Destructor Documentation

◆ SparseSet() [1/2]

template<class Type>
juce::SparseSet< Type >::SparseSet ( )
inline

Creates a new empty set.

◆ SparseSet() [2/2]

template<class Type>
juce::SparseSet< Type >::SparseSet ( const SparseSet< Type > &  other)
inline

Creates a copy of another SparseSet.

Member Function Documentation

◆ addRange()

template<class Type>
void juce::SparseSet< Type >::addRange ( const 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.

◆ clear()

template<class Type>
void juce::SparseSet< Type >::clear ( )
inline

Clears the set.

◆ contains()

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

Checks whether a particular value is in the set.

◆ containsRange()

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

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

◆ getNumRanges()

template<class Type>
int juce::SparseSet< Type >::getNumRanges ( ) const
inlinenoexcept

Returns the number of contiguous blocks of values.

See also
getRange

◆ getRange()

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

Returns one of the contiguous ranges of values stored.

Parameters
rangeIndexthe index of the range to look up, between 0 and (getNumRanges() - 1)
See also
getTotalRange

◆ getTotalRange()

template<class Type>
Range<Type> juce::SparseSet< Type >::getTotalRange ( ) const
inline

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

See also
getRange

◆ invertRange()

template<class Type>
void juce::SparseSet< Type >::invertRange ( const Range< Type >  range)
inline

Does an XOR of the values in a given range.

◆ 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).

◆ operator!=()

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

◆ operator==()

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

◆ operator[]()

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

Returns one of the values in the set.

Parameters
indexthe 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

◆ overlapsRange()

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

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

◆ removeRange()

template<class Type>
void juce::SparseSet< Type >::removeRange ( const 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.

◆ size()

template<class Type>
Type juce::SparseSet< Type >::size ( ) const
inline

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.


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