Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

PartialList.h

00001 #ifndef INCLUDE_PARTIALLIST_H
00002 #define INCLUDE_PARTIALLIST_H
00003 /*
00004  * This is the Loris C++ Class Library, implementing analysis, 
00005  * manipulation, and synthesis of digitized sounds using the Reassigned 
00006  * Bandwidth-Enhanced Additive Sound Model.
00007  *
00008  * Loris is Copyright (c) 1999-2004 by Kelly Fitz and Lippold Haken
00009  *
00010  * This program is free software; you can redistribute it and/or modify
00011  * it under the terms of the GNU General Public License as published by
00012  * the Free Software Foundation; either version 2 of the License, or
00013  * (at your option) any later version.
00014  *
00015  * This program is distributed in the hope that it will be useful,
00016  * but WITHOUT ANY WARRANTY, without even the implied warranty of
00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00018  * GNU General Public License for more details.
00019  *
00020  * You should have received a copy of the GNU General Public License
00021  * along with this program; if not, write to the Free Software
00022  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00023  *
00024  *
00025  *  PartialList.h
00026  *
00027  *  Type definition of Loris::PartialList, which is just a name
00028  *  for std::list< Loris::Partial >.
00029  *
00030  * Kelly Fitz, 6 March 2002
00031  * loris@cerlsoundgroup.org
00032  *
00033  * http://www.cerlsoundgroup.org/Loris/
00034  *
00035  */
00036  
00037 //  Seems like we shouldn't need to include Partial.h, but 
00038 //  without it, I can't instantiate a PartialList. I need
00039 //  a definition of Partial for PartialList to be unambiguous.
00040 #include "Partial.h"
00041 #include <list>
00042 
00043 //  begin namespace
00044 namespace Loris {
00045 
00046 // ---------------------------------------------------------------------------
00047 //  class PartialList
00048 //
00049 //  PartialList is a typedef for a std::list<> of Loris Partials. The
00050 //  oscciated bidirectional iterators are also defined as
00051 //  PartialListIterator and PartialListConstIterator. Since these are
00052 //  simply typedefs, they classes have identical interfaces to std::list,
00053 //  std::list::iterator, and std::list::const_iterator, respectively.
00054 //
00055 typedef std::list< Loris::Partial > PartialList;
00056 typedef std::list< Loris::Partial >::iterator PartialListIterator;
00057 typedef std::list< Loris::Partial >::const_iterator PartialListConstIterator;
00058 
00059 }   //  end of namespace Loris
00060 
00061 #endif /* ndef INCLUDE_PARTIALLIST_H */

Generated on Thu Apr 14 22:01:55 2005 for Loris by doxygen 1.3.4