PointSubset.h

Go to the documentation of this file.

/******************************************************************************
*       SOFA, Simulation Open-Framework Architecture, version 1.0 beta 3      *
*                (c) 2006-2008 MGH, INRIA, USTL, UJF, CNRS                    *
*                                                                             *
* This library is free software; you can redistribute it and/or modify it     *
* under the terms of the GNU Lesser General Public License as published by    *
* the Free Software Foundation; either version 2.1 of the License, or (at     *
* your option) any later version.                                             *
*                                                                             *
* This library 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 Lesser General Public License *
* for more details.                                                           *
*                                                                             *
* You should have received a copy of the GNU Lesser General Public License    *
* along with this library; if not, write to the Free Software Foundation,     *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.          *
*******************************************************************************
*                               SOFA :: Modules                               *
*                                                                             *
* Authors: The SOFA Team and external contributors (see Authors.txt)          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
#ifndef SOFA_COMPONENT_TOPOLOGY_POINTSUBSET_H
#define SOFA_COMPONENT_TOPOLOGY_POINTSUBSET_H

#include <sofa/helper/vector.h>
#include <list>
#include <iostream>

namespace sofa
{
    namespace core{ namespace componentmodel{ namespace topology{ class TopologyChange; }}}

namespace component
{

namespace topology
{

    inline bool ps_testNewPointFunc(int , void* , 
                                    const sofa::helper::vector< unsigned int > &,
                                    const sofa::helper::vector< double       > &)
    {
        return false;
    }

    inline void ps_removeFunc(int , void* )
    {
        return;
    }

    class PointSubset 
    {
    public:
        // forwardinging Commonvector methods and typdefs
        typedef  helper::vector<unsigned int>::value_type                value_type;
        typedef  helper::vector<unsigned int>::pointer                   pointer;
        typedef  helper::vector<unsigned int>::reference                 reference;
        typedef  helper::vector<unsigned int>::const_reference           const_reference;
        typedef  helper::vector<unsigned int>::size_type                 size_type;
        typedef  helper::vector<unsigned int>::difference_type          difference_type;
        typedef  helper::vector<unsigned int>::iterator                  iterator;
        typedef  helper::vector<unsigned int>::const_iterator            const_iterator;
        typedef  helper::vector<unsigned int>::reverse_iterator          reverse_iterator;
        typedef  helper::vector<unsigned int>::const_reverse_iterator    const_reverse_iterator;

    public:
        PointSubset( bool (*testNewPointFunc)(int, void*, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double >&)=ps_testNewPointFunc, 
                    void* testParam  = (void*)NULL, 
                    void (*removeFunc)(int, void*) = ps_removeFunc, 
                    void* removeParam = (void*)NULL ) 
        : m_testNewPointFunc(testNewPointFunc), 
        m_removalFunc(removeFunc), m_testParam(testParam), m_removeParam(removeParam), lastPointIndex(0)
        {}

        void handleTopologyEvents( std::list< const core::componentmodel::topology::TopologyChange *>::const_iterator changeIt, 
                                std::list< const core::componentmodel::topology::TopologyChange *>::const_iterator &end,
                                const unsigned int totalPointSetArraySize);

        // defining operators so that pointSubset can be used in a Data (see Data class).
        friend std::ostream& operator<< (std::ostream& ostream, const PointSubset& pointSubset);
        friend std::istream& operator>> (std::istream& i,             PointSubset& pointSubset);

        void setTestFunction(bool (*testNewPointFunc )(int, void*, const sofa::helper::vector< unsigned int > &, 
                                                        const sofa::helper::vector< double >& )) 
        {
            m_testNewPointFunc=testNewPointFunc;
        }

        void setRemovalFunction( void (*removeFunc)(int, void*) ) 
        {
            m_removalFunc=removeFunc;
        }

        void setRemovalParameter( void* removeParam ) 
        {
            m_removeParam=removeParam;
        }

        void setTestParameter( void* testParam ) 
        {
            m_testParam=testParam;
        }

        const helper::vector< unsigned int > & getArray() const { return m_subset; }

        iterator begin() { return m_subset.begin(); }

        iterator end() {return m_subset.end(); }

        const_iterator begin() const { return m_subset.begin(); }

        const_iterator end() const { return m_subset.end(); }

        reverse_iterator rbegin() { return m_subset.rbegin(); }

        reverse_iterator rend() { return m_subset.rend(); }

        const_reverse_iterator rbegin() const { return m_subset.rbegin(); }

        const_reverse_iterator rend() const { return m_subset.rend(); }

        size_type size() const { return m_subset.size(); }

        size_type max_size() const { return m_subset.max_size(); }

        size_type capacity() const { return m_subset.capacity(); }

        bool empty() const { return m_subset.empty(); }

        reference operator[]( size_type n ) { return m_subset[n]; }

        const_reference operator[]( size_type i ) const { return m_subset[i]; }

        //        PointSubset& operator=( const sofa::helper::vector<unsigned int> & vector ) { m_subset( vector ); return *this; }

        //        PointSubset& operator=( const PointSubset& pointSubset ) { m_subset( pointSubset.m_subset ); return *this; }

        void reserve( size_t n ) { m_subset.reserve( n ); }

        reference front() { return m_subset.front(); }

        const_reference front() const { return m_subset.front(); }

        reference back() { return m_subset.back(); }

        const_reference back() const { return m_subset.back(); }

        void push_back( const unsigned int  t ) { m_subset.push_back( t ); }

        void pop_back() { m_subset.pop_back(); }

        void swap( helper::vector<unsigned int> &vector ) { m_subset.swap( vector ); }

        void swap( PointSubset &pointSubset) { m_subset.swap( pointSubset.m_subset ); }

        void clear() { m_subset.clear(); }

        void resize( size_t n ) { m_subset.resize( n ); }

    private:
        void swap( unsigned int i1, unsigned int i2 );

        void add( unsigned int nbPoints, 
                const sofa::helper::vector< sofa::helper::vector< unsigned int > >& ancestors,
                const sofa::helper::vector< sofa::helper::vector< double       > >& coefs);

        void remove( const sofa::helper::vector<unsigned int> &index );

        void renumber( const sofa::helper::vector<unsigned int> &index );

        void setTotalPointSetArraySize(const unsigned int s) { lastPointIndex=s-1; }

    private:
        helper::vector< unsigned int > m_subset;

        bool (*m_testNewPointFunc)(int, void*, const sofa::helper::vector< unsigned int > &, const sofa::helper::vector< double >&);

        void (*m_removalFunc)(int, void*);

        void* m_testParam;

        void* m_removeParam;

        unsigned int lastPointIndex;
    };

    std::ostream& operator<< (std::ostream& os, const PointSubset& pointSubset);

    std::istream& operator>>(std::istream& i, PointSubset& pointSubset);

} // namespace topology

} // namespace component

} // namespace sofa

#endif // _POINTSUBSET_H_