ChromaticIndex.h

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

class ChromaticIndex {
public:
    static constexpr int16_t Minimum = -1528;

    static constexpr int16_t Maximum = 1551;

    static constexpr int16_t InvalidValue = 32767;
 
private:
    int16_t _value;
 
public:
    constexpr ChromaticIndex() noexcept : _value(InvalidValue) {}

    constexpr explicit ChromaticIndex(int32_t value) noexcept
        : _value((value >= Minimum && value <= Maximum)
              ? static_cast<int16_t>(value)
              : InvalidValue) {}

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

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

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

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

    MCC_CONSTEXPR14 ChromaticIndex Transposed(int32_t semitones) const noexcept {
        if (!IsValid() ||
            semitones < Minimum - Maximum ||
            semitones > Maximum - Minimum) {
            return Invalid();
        }
        return ChromaticIndex(static_cast<int32_t>(_value) + semitones);
    }

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

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