/Users/kfitz/Projects/Loris/Loris development/src/LinearEnvelope.h

#ifndef INCLUDE_LINEARENVELOPE_H
#define INCLUDE_LINEARENVELOPE_H
/*
 * This is the Loris C++ Class Library, implementing analysis, 
 * manipulation, and synthesis of digitized sounds using the Reassigned 
 * Bandwidth-Enhanced Additive Sound Model.
 *
 * Loris is Copyright (c) 1999-2010 by Kelly Fitz and Lippold Haken
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * LinearEnvelope.h
 *
 * Definition of class LinearEnvelope.
 *
 * Kelly Fitz, 23 April 2005
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Envelope.h"
#include <map>

//  begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//  class LinearEnvelope
//
//
class LinearEnvelope : public Envelope, private std::map< double, double >
{
//  -- public interface --
public:
//  -- construction --

    LinearEnvelope( void );

    explicit LinearEnvelope( double initialValue );

    //  compiler-generated copy, assignment, and destruction are OK.
    
//  -- Envelope interface --

    virtual LinearEnvelope * clone( void ) const;

    virtual double valueAt( double t ) const;   
        
    
//  -- envelope composition --

    void insert( double time, double value );
    
    void insertBreakpoint( double time, double value ) 
         { insert( time, value ); }
         
         
    LinearEnvelope & operator+=( double offset );

    LinearEnvelope & operator-=( double offset )
    {
        return operator+=( -offset );
    }

    LinearEnvelope & operator*=( double scale );

    LinearEnvelope & operator/=( double div )
    {
        return operator*=( 1.0 / div );
    }

//  -- interface inherited from std::map --

    using std::map< double, double >::size;
    using std::map< double, double >::empty;
    using std::map< double, double >::clear;
    using std::map< double, double >::begin;
    using std::map< double, double >::end;
    using std::map< double, double >::size_type;
    using std::map< double, double >::value_type;
    using std::map< double, double >::iterator;
    using std::map< double, double >::const_iterator;

};  //  end of class LinearEnvelope


//  --  binary operators (inline nonmembers) --

inline
LinearEnvelope operator+( LinearEnvelope env, double offset )
{
    env += offset;
    return env;
}

inline
LinearEnvelope operator+( double offset, LinearEnvelope env )
{
    env += offset;
    return env;
}

inline
LinearEnvelope operator+( const LinearEnvelope & e1, const LinearEnvelope & e2 )
{
        LinearEnvelope ret;
        
        //      For each breakpoint in e1, insert a breakpoint having a value
        //      equal to the sum of the two envelopes at that time.
        for ( LinearEnvelope::const_iterator it = e1.begin(); it != e1.end(); ++it )
        {
                double t = it->first;
                double v = it->second;
                        
                ret.insert( t, v + e2.valueAt( t ) );
        }
        
        //      For each breakpoint in e2, insert a breakpoint having a value
        //      equal to the sum of the two envelopes at that time.
        for ( LinearEnvelope::const_iterator it = e2.begin(); it != e2.end(); ++it )
        {
                double t = it->first;
                double v = it->second;
                        
                ret.insert( t, v + e1.valueAt( t ) );
        }

    return ret;
}

inline
LinearEnvelope operator-( LinearEnvelope env, double offset )
{
    env -= offset;
    return env;
}

inline
LinearEnvelope operator-( double offset, LinearEnvelope env )
{
    env *= -1.0;
    env += offset;
    return env;
}

inline
LinearEnvelope operator-( const LinearEnvelope & e1, const LinearEnvelope & e2 )
{
        LinearEnvelope ret;
        
        //      For each breakpoint in e1, insert a breakpoint having a value
        //      equal to the difference between the two envelopes at that time.
        for ( LinearEnvelope::const_iterator it = e1.begin(); it != e1.end(); ++it )
        {
                double t = it->first;
                double v = it->second;
                        
                ret.insert( t, v - e2.valueAt( t ) );
        }
        
        //      For each breakpoint in e2, insert a breakpoint having a value
        //      equal to the difference between the two envelopes at that time.
        for ( LinearEnvelope::const_iterator it = e2.begin(); it != e2.end(); ++it )
        {
                double t = it->first;
                double v = it->second;
                        
                ret.insert( t, e1.valueAt( t ) - v );
        }

    return ret;
}

inline
LinearEnvelope operator*( LinearEnvelope env, double scale )
{
    env *= scale;
    return env;
}

inline
LinearEnvelope operator*( double scale, LinearEnvelope env )
{
    env *= scale;
    return env;
}

inline
LinearEnvelope operator/( LinearEnvelope env, double div )
{
    env /= div;
    return env;
}

LinearEnvelope operator/( double scale, LinearEnvelope env );


}   //  end of namespace Loris

#endif /* ndef INCLUDE_LINEARENVELOPE_H */

---