Collator.h

#ifndef INCLUDE_COLLATOR_H
#define INCLUDE_COLLATOR_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
 *
 *
 * Collator.h
 *
 * Definition of class Collator.
 *
 * Kelly Fitz, 29 April 2005
 * loris@cerlsoundgroup.org
 *
 * http://www.cerlsoundgroup.org/Loris/
 *
 */

#include "Partial.h"
#include "PartialList.h"
#include "PartialUtils.h"

#include <algorithm>

//  begin namespace
namespace Loris {

// ---------------------------------------------------------------------------
//  class Collator
//
//
class Collator
{
//  -- instance variables --

    double _fadeTime, _gapTime;       
        
//  -- public interface --
public:

//  -- global defaults and constants --

    static const double DefaultFadeTime;
    
    static const double DefaultSilentTime;
    
//  -- construction --

    explicit
    Collator( double partialFadeTime = Collator::DefaultFadeTime,
              double partialSilentTime = Collator::DefaultSilentTime );
     
    //  Use compiler-generated copy, assign, and destroy.
    
//  -- collating --

#if ! defined(NO_TEMPLATE_MEMBERS)
    template< typename Container >
    typename Container::iterator collate( Container & partials );
#else
    inline
    PartialList::iterator collate( PartialList & partials );
#endif

#if ! defined(NO_TEMPLATE_MEMBERS)
    template< typename Container >
    typename Container::iterator operator() ( Container & partials );
#else
    PartialList::iterator operator() ( PartialList & partials );
#endif
    
#if ! defined(NO_TEMPLATE_MEMBERS)
    template< typename Container >
    static typename Container::iterator 
    collate( Container & partials, double partialFadeTime,
                                   double partialSilentTime );
#else
    static inline PartialList::iterator
    collate( PartialList & partials, double partialFadeTime,
                                     double partialSilentTime );
#endif


private:

//  -- helpers --

    void collateAux( PartialList & unlabled );
    
};  //  end of class Collator

// ---------------------------------------------------------------------------
//  collate
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Container >
typename Container::iterator 
Collator::collate( Container & partials )
#else
inline
PartialList::iterator 
Collator::collate( PartialList & partials )
#endif
{
#if ! defined(NO_TEMPLATE_MEMBERS)
    typedef typename Container::iterator Iterator;
#else
    typedef PartialList::iterator Iterator;
#endif

    // Partition the Partials into labeled and unlabeled, 
    // and collate the unlabeled ones and replace the 
    // unlabeled range.
    // (This requires bidirectional iterator support.)
    Iterator beginUnlabeled = 
       std::partition( partials.begin(), partials.end(), 
                              std::not1( PartialUtils::isLabelEqual(0) ) );
        //  this used to be a stable partition, which 
        //  is very much slower and seems unnecessary
        
    // cannot splice if this operation is to be generic
    // with respect to container, have to copy:
    PartialList collated( beginUnlabeled, partials.end() );
    // collated.splice( collated.end(), beginUnlabeled, partials.end() );
    
    //  determine the label for the first collated Partial:
    Partial::label_type labelCollated = 1;
    if ( partials.begin() != beginUnlabeled )
    {
       labelCollated = 
        1 + std::max_element( partials.begin(), beginUnlabeled, 
                              PartialUtils::compareLabelLess() )->label();
    }
    if ( labelCollated < 1 )
    {
        labelCollated = 1;
    }

    //  collate unlabeled (zero-labeled) Partials:
    collateAux( collated );
    
    //  label the collated Partials:
    for ( Iterator it = collated.begin(); it != collated.end(); ++it )
    {
        it->setLabel( labelCollated++ );
    }
    
    //  copy the collated Partials back into the source container
    //  after the range of labeled Partials     
    Iterator endCollated = 
        std::copy( collated.begin(), collated.end(), beginUnlabeled );

    //  remove extra Partials from the end of the source container
    if ( endCollated != partials.end() )
    {
        typename Iterator::difference_type numLabeled = 
            std::distance( partials.begin(), beginUnlabeled );

        partials.erase( endCollated, partials.end() );

        // restore beginUnlabeled:    
        beginUnlabeled = partials.begin();
        std::advance( beginUnlabeled, numLabeled );
    }
    return beginUnlabeled;
}

// ---------------------------------------------------------------------------
//  Function call operator 
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Container >
typename Container::iterator Collator::operator()( Container & partials )
#else
inline
PartialList::iterator Collator::operator()( PartialList & partials )
#endif
{ 
    return collate( partials );
}

// ---------------------------------------------------------------------------
//  collate
// ---------------------------------------------------------------------------
//
#if ! defined(NO_TEMPLATE_MEMBERS)
template< typename Container >
typename Container::iterator 
Collator::collate( Container & partials, double partialFadeTime,
                                         double partialSilentTime )
#else
inline
PartialList::iterator 
Collator::collate( PartialList & partials, double partialFadeTime,
                                           double partialSilentTime )
#endif
{
    Collator instance( partialFadeTime, partialSilentTime );
    return instance.collate( partials );
}

}   //  end of namespace Loris

#endif /* ndef INCLUDE_COLLATOR_H */

---