pulp::music::ChordRecognitionList Class Reference

#include <harmony.hpp>

Public Member Functions
constexpr std::size_t	size () const noexcept
constexpr std::size_t	best_equivalent_count () const noexcept
constexpr bool	ambiguous () const noexcept
constexpr std::optional< ChordRecognition >	candidate (std::size_t index) const noexcept

Static Public Attributes
static constexpr std::size_t	kMaxCandidates = kPitchClassesPerOctave * kChordQualityCount

Friends
constexpr std::optional< ChordRecognitionList >	recognize_chord (PitchClassSet pitch_classes, std::optional< PitchClass > bass=std::nullopt)

Member Function Documentation

ambiguous()

bool pulp::music::ChordRecognitionList::ambiguous ( ) const

inlineconstexprnoexcept

best_equivalent_count()

std::size_t pulp::music::ChordRecognitionList::best_equivalent_count ( ) const

inlineconstexprnoexcept

candidate()

std::optional< ChordRecognition > pulp::music::ChordRecognitionList::candidate ( std::size_t index ) const

inlineconstexprnoexcept

size()

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

inlineconstexprnoexcept

Friends And Related Symbol Documentation

recognize_chord

std::optional< ChordRecognitionList > recognize_chord ( PitchClassSet pitch_classes, std::optional< PitchClass > bass = std::nullopt )

friend

Member Data Documentation

kMaxCandidates

std::size_t pulp::music::ChordRecognitionList::kMaxCandidates = kPitchClassesPerOctave * kChordQualityCount

staticconstexpr

---

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

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