Partial.h

#ifndef INCLUDE_PARTIAL_H
#define INCLUDE_PARTIAL_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-2007 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
 *
 *
 * Partial.h
 *
 * Definition of class Loris::Partial, and definitions and implementations of
 * classes of const and non-const iterators over Partials, and the exception
 * class InvalidPartial, thrown by some Partial members when invoked on a 
 * degenerate Partial having no Breakpoints.
 *
 * Kelly Fitz, 16 Aug 1999
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Breakpoint.h"
#include "LorisExceptions.h"

#include <map>
//#include <utility>
//#include <vector>

//  begin namespace
namespace Loris {

class Partial_Iterator;
class Partial_ConstIterator;

// ---------------------------------------------------------------------------
//  class Partial
//
//
class Partial
{   
//  -- public interface --
public:

//  -- types --

    typedef std::map< double, Breakpoint > container_type;
    
    //  typedef std::vector< std::pair< double, Breakpoint > > container_type;
    //  see Partial.C for a discussion of issues surrounding the 
    //  choice of std::map as a Breakpoint container.

    typedef int label_type; 
    
    typedef Partial_Iterator iterator;  
    
    typedef Partial_ConstIterator const_iterator;
    
    typedef container_type::size_type size_type;

//  -- construction --

    Partial( void );
     
    Partial( const_iterator beg, const_iterator end );
     
    Partial( const Partial & other );
     
    ~Partial( void );
     
//  -- assignment --

    Partial & operator=( const Partial & other );

//  -- container-dependent implementation --

    iterator begin( void );
     
    const_iterator begin( void ) const;
    
    iterator end( void );

    const_iterator end( void ) const;

    iterator erase( iterator beg, iterator end );

    iterator findAfter( double time );

    const_iterator findAfter( double time ) const;

    iterator insert( double time, const Breakpoint & bp );

    size_type size( void ) const;
            
//  -- access --

    double duration( void ) const;
     
    double endTime( void ) const;
     
    Breakpoint & first( void );

    const Breakpoint & first( void ) const;
     
    double initialPhase( void ) const;
         
    label_type label( void ) const;

    Breakpoint & last( void );
    
    const Breakpoint & last( void ) const;
     
    size_type numBreakpoints( void ) const;

    double startTime( void ) const;
     
//  -- mutation --

    void absorb( const Partial & other );

    void setLabel( label_type l );

    iterator erase( iterator pos );
     
    iterator findNearest( double time );

    const_iterator findNearest( double time ) const;

    Partial split( iterator pos );
     
//  -- parameter interpolation/extrapolation --

    static const double ShortestSafeFadeTime;   

    double amplitudeAt( double time, double fadeTime = ShortestSafeFadeTime ) const;

    double bandwidthAt( double time ) const;
     
    double frequencyAt( double time ) const;
     
    double phaseAt( double time ) const;

    Breakpoint parametersAt( double time, double fadeTime = ShortestSafeFadeTime ) const;

//  -- implementation --
private:

    label_type _label;
    container_type _breakpoints;    //  Breakpoint envelope
     
};  //  end of class Partial

// ---------------------------------------------------------------------------
//  class Partial_Iterator
//
//
class Partial_Iterator
{
//  -- instance variables --

    typedef Partial::container_type BaseContainer;
    typedef BaseContainer::iterator BaseIterator;
    BaseIterator _iter;
    
//  -- public interface --
public:
//  -- bidirectional iterator interface --

    typedef BaseIterator::iterator_category iterator_category;
    
    typedef Breakpoint                      value_type;
    
    typedef BaseIterator::difference_type   difference_type;
    
    typedef Breakpoint *                    pointer;

    typedef Breakpoint &                    reference;

//  construction:
    
    Partial_Iterator( void ) {}
    
    //  (allow compiler to generate copy, assignment, and destruction)
    
//  pre-increment/decrement:

    Partial_Iterator& operator ++ () { ++_iter; return *this; }

    Partial_Iterator& operator -- () { --_iter; return *this; }

//  post-increment/decrement:

    Partial_Iterator operator ++ ( int ) { return Partial_Iterator( _iter++ ); } 

    Partial_Iterator operator -- ( int ) { return Partial_Iterator( _iter-- ); } 
    
//  dereference (for treating Partial like a 
//  STL collection of Breakpoints):

    Breakpoint & operator * ( void ) const { return breakpoint(); }


    //Breakpoint & operator * ( void ) { return breakpoint(); }
    
    Breakpoint * operator -> ( void ) const  { return & breakpoint(); }

    //Breakpoint * operator -> ( void )  { return & breakpoint(); }
        
//  comparison:

    friend bool operator == ( const Partial_Iterator & lhs, 
                              const Partial_Iterator & rhs )
        { return lhs._iter == rhs._iter; }

    friend bool operator != ( const Partial_Iterator & lhs, 
                              const Partial_Iterator & rhs )
        { return lhs._iter != rhs._iter; }
    
//  -- time and Breakpoint access --

    Breakpoint & breakpoint( void ) const 
        { return _iter->second; }

    //Breakpoint & breakpoint( void ) 
    //  { return _iter->second; }

    double time( void ) const  
        { return _iter->first; }

//  -- BaseIterator conversions --
private:
    //  construction by GenericBreakpointContainer from a BaseIterator:
    Partial_Iterator( const BaseIterator & it ) :
        _iter(it) {}

    friend class Partial;
    
    //  befriend  Partial_ConstIterator, 
    //  for const construction from non-const:
    friend class Partial_ConstIterator; 
    
};  //  end of class Partial_Iterator

// ---------------------------------------------------------------------------
//  class Partial_ConstIterator
//
//
class Partial_ConstIterator
{
//  -- instance variables --
    typedef Partial::container_type BaseContainer;
    typedef BaseContainer::const_iterator BaseIterator;
    BaseIterator _iter;
    
//  -- public interface --
public:
//  -- bidirectional iterator interface --

    typedef BaseIterator::iterator_category iterator_category;
    
    typedef Breakpoint                      value_type;
    
    typedef BaseIterator::difference_type   difference_type;
    
    typedef const Breakpoint *                  pointer;

    typedef const Breakpoint &                  reference;

//  construction:

    Partial_ConstIterator( void ) {}
    
    Partial_ConstIterator( const Partial_Iterator & other ) :
        _iter( other._iter ) {}
    
    //  (allow compiler to generate copy, assignment, and destruction):

//  pre-increment/decrement:

    Partial_ConstIterator& operator ++ () { ++_iter; return *this; }

    Partial_ConstIterator& operator -- () { --_iter; return *this; }

//  post-increment/decrement:

    Partial_ConstIterator operator ++ ( int ) { return Partial_ConstIterator( _iter++ ); } 

    Partial_ConstIterator operator -- ( int ) { return Partial_ConstIterator( _iter-- ); } 
    
//  dereference (for treating Partial like a 
//  STL collection of Breakpoints):

    const Breakpoint & operator * ( void ) const { return breakpoint(); }

    const Breakpoint * operator -> ( void ) const { return & breakpoint(); }
    
//  comparison:

    friend bool operator == ( const Partial_ConstIterator & lhs, 
                              const Partial_ConstIterator & rhs )
        { return lhs._iter == rhs._iter; }

    friend bool operator != ( const Partial_ConstIterator & lhs, 
                              const Partial_ConstIterator & rhs )
        { return lhs._iter != rhs._iter; }
    
//  -- time and Breakpoint access --

    const Breakpoint & breakpoint( void ) const 
        { return _iter->second; }

    double time( void ) const  
        { return _iter->first; }
    
//  -- BaseIterator conversions --
private:
    //  construction by GenericBreakpointContainer from a BaseIterator:
    Partial_ConstIterator( BaseIterator it ) :
        _iter(it) {}
    
    friend class Partial;

};  //  end of class Partial_ConstIterator

// ---------------------------------------------------------------------------
//  class InvalidPartial
//
//
class InvalidPartial : public InvalidObject
{
public: 

    InvalidPartial( const std::string & str, const std::string & where = "" ) : 
        InvalidObject( std::string("Invalid Partial -- ").append( str ), where ) {}
        
};  //  end of class InvalidPartial

}   //  end of namespace Loris

#endif /* ndef INCLUDE_PARTIAL_H */

---