pulp::music::PitchClassSet Class Reference

#include <pitch.hpp>

Public Member Functions
constexpr	PitchClassSet () noexcept=default
constexpr std::uint16_t	mask () const noexcept
constexpr bool	empty () const noexcept
constexpr std::size_t	size () const noexcept
constexpr bool	contains (PitchClass pitch_class) const noexcept
constexpr std::optional< PitchClass >	at (std::size_t index) const noexcept
constexpr std::optional< std::size_t >	index_of (PitchClass pitch_class) const noexcept
constexpr PitchClassSet	transposed (int semitones) const noexcept
constexpr PitchClassSet	inverted (PitchClass axis=PitchClass::c) const noexcept
constexpr auto	operator<=> (const PitchClassSet &) const =default

Static Public Member Functions
static constexpr std::optional< PitchClassSet >	from_mask (std::uint16_t mask) noexcept
static constexpr std::optional< PitchClassSet >	from_pitch_classes (std::span< const PitchClass > pitch_classes) noexcept

Constructor & Destructor Documentation

PitchClassSet()

pulp::music::PitchClassSet::PitchClassSet ( )

constexprdefaultnoexcept

Member Function Documentation

at()

std::optional< PitchClass > pulp::music::PitchClassSet::at ( std::size_t index ) const

inlineconstexprnoexcept

contains()

bool pulp::music::PitchClassSet::contains ( PitchClass pitch_class ) const

inlineconstexprnoexcept

empty()

bool pulp::music::PitchClassSet::empty ( ) const

inlineconstexprnoexcept

from_mask()

constexpr std::optional< PitchClassSet > pulp::music::PitchClassSet::from_mask ( std::uint16_t mask )

inlinestaticconstexprnoexcept

from_pitch_classes()

constexpr std::optional< PitchClassSet > pulp::music::PitchClassSet::from_pitch_classes ( std::span< const PitchClass > pitch_classes )

inlinestaticconstexprnoexcept

index_of()

std::optional< std::size_t > pulp::music::PitchClassSet::index_of ( PitchClass pitch_class ) const

inlineconstexprnoexcept

inverted()

PitchClassSet pulp::music::PitchClassSet::inverted ( PitchClass axis = PitchClass::c ) const

inlineconstexprnoexcept

mask()

std::uint16_t pulp::music::PitchClassSet::mask ( ) const

inlineconstexprnoexcept

operator<=>()

auto pulp::music::PitchClassSet::operator<=> ( const PitchClassSet & ) const

constexprdefault

size()

std::size_t pulp::music::PitchClassSet::size ( ) const

inlineconstexprnoexcept

transposed()

PitchClassSet pulp::music::PitchClassSet::transposed ( int semitones ) const

inlineconstexprnoexcept

---

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

• /home/runner/work/pulp/pulp/core/music/include/pulp/music/pitch.hpp