juce_Phase.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
namespace dsp
{

template <typename Type>
struct Phase
{
    void reset() noexcept               { phase = 0; }

    Type advance (Type increment) noexcept
    {
        jassert (increment >= 0); // cannot run this value backwards!
 
        auto last = phase;
        auto next = last + increment;
 
        while (next >= MathConstants<Type>::twoPi)
            next -= MathConstants<Type>::twoPi;
 
        phase = next;
        return last;
    }
 
    Type phase = 0;
};
 
} // namespace dsp
} // namespace juce