PitchClass.h

#ifndef MCC_PITCH_PITCH_CLASS_H
#define MCC_PITCH_PITCH_CLASS_H
 
#include <MCC_BuildSettings.h>
 
#include <stdint.h>
 
#include <Foundation/Math/Arithmetic.h>
 
namespace MCC {

class PitchClass {
public:
    static constexpr uint8_t Count = 12;

    static constexpr uint8_t InvalidValue = 0xFF;
 
private:
    uint8_t _value;
 
public:
    constexpr PitchClass() noexcept : _value(InvalidValue) {}

    constexpr explicit PitchClass(int32_t value) noexcept
        : _value((value >= 0 && value < Count)
              ? static_cast<uint8_t>(value)
              : InvalidValue) {}

    static constexpr PitchClass Invalid() noexcept {
        return PitchClass();
    }

    constexpr bool IsValid() const noexcept { return _value != InvalidValue; }

    constexpr uint8_t Value() const noexcept { return _value; }

    MCC_CONSTEXPR14 PitchClass Transposed(int32_t semitones) const noexcept {
        if (!IsValid()) {
            return Invalid();
        }
        return PitchClass(Foundation::Math::FloorMod(
            _value + Foundation::Math::FloorMod(semitones, Count), Count));
    }

    friend constexpr bool operator==(PitchClass a, PitchClass b) noexcept {
        return a._value == b._value;
    }
 
    friend constexpr bool operator!=(PitchClass a, PitchClass b) noexcept {
        return !(a == b);
    }

    friend constexpr bool operator<(PitchClass a, PitchClass b) noexcept {
        return a._value < b._value;
    }
 
    friend constexpr bool operator>(PitchClass a, PitchClass b) noexcept {
        return b < a;
    }
 
    friend constexpr bool operator<=(PitchClass a, PitchClass b) noexcept {
        return !(b < a);
    }
 
    friend constexpr bool operator>=(PitchClass a, PitchClass b) noexcept {
        return !(a < b);
    }
};
 
} // namespace MCC
 
#endif // MCC_PITCH_PITCH_CLASS_H