Fundamental.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * 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
 *
 */

#ifndef _Fundamental_
#define _Fundamental_
#include <typeinfo>
#include "DynamicType.hxx"
#include "Array.hxx"
#include "DataTypes.hxx"
#include "OSDefines.hxx"
#include "Err.hxx"
#include "ProcessingData.hxx"

namespace CLAM
{

        // Class Fundamental:
        //

        class Fundamental : public ProcessingData
        {
        public:
                DYNAMIC_TYPE_USING_INTERFACE (Fundamental, 2, ProcessingData);
                DYN_ATTRIBUTE (0, public, DataArray, CandidatesFreq);
                DYN_ATTRIBUTE (1, public, DataArray, CandidatesErr);

        protected:
                void DefaultInit();

        public:
                void SetnMaxCandidates(TSize nMaxCandidates)
                {
                        if (HasCandidatesFreq())
                                GetCandidatesFreq().Resize(nMaxCandidates);

                        if (HasCandidatesErr())
                                GetCandidatesErr().Resize(nMaxCandidates);
                }

                TSize GetnMaxCandidates() const
                {
                        if (HasCandidatesFreq())
                                return GetCandidatesFreq().AllocatedSize();

                        if (HasCandidatesErr())
                                return GetCandidatesErr().AllocatedSize();

                        return 0;
                }

                void SetnCandidates(int size)
                {
                        if (HasCandidatesFreq())
                                GetCandidatesFreq().SetSize(size);

                        if (HasCandidatesErr())
                                GetCandidatesErr().SetSize(size);
                }

                int GetnCandidates() const
                {
                        if (HasCandidatesFreq())
                                return GetCandidatesFreq().Size();

                        if (HasCandidatesErr())
                                return GetCandidatesErr().Size();

                        return 0;
                }
                
                TData GetFreq(TIndex pos=0) const;

                TData GetErr(TIndex pos=0) const;


                void SetFreq(TIndex pos,TData newFreq);

                void SetErr(TIndex pos,TData newErr);
                
                // Other functionality
                
                void AddElem (TData freq=0.f, TData err=0.f);

                void InsertElem (TIndex pos, TData freq=0.f, TData err=0.f);

                void DeleteElem (TIndex pos);

  
                // Ordering functions

                void SortByFrequency();

                void SortByError();

                void Init()
                {
                        GetCandidatesFreq().SetSize(0);
                        GetCandidatesErr().SetSize(0);
                        SetnCandidates(0);
                }
        };

} // namespace CLAM

#endif