external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp

Go to the documentation of this file.

/*
 *      This file is part of qpOASES.
 *
 *      qpOASES -- An Implementation of the Online Active Set Strategy.
 *      Copyright (C) 2007-2015 by Hans Joachim Ferreau, Andreas Potschka,
 *      Christian Kirches et al. All rights reserved.
 *
 *      qpOASES 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.
 *
 *      qpOASES 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 qpOASES; if not, write to the Free Software
 *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */


#ifndef QPOASES_INDEXLIST_HPP
#define QPOASES_INDEXLIST_HPP


#include <qpOASES/Utils.hpp>


BEGIN_NAMESPACE_QPOASES


class Indexlist
{
        /*
         *  FRIENDS
         */
        friend class DenseMatrix;
        friend class SymDenseMat;
        friend class SparseMatrix;
        friend class SparseMatrixRow;
        friend class SymSparseMat;

        /*
         *      PUBLIC MEMBER FUNCTIONS
         */
        public:
                Indexlist( );

                Indexlist(      int_t n 
                                        );

                Indexlist(      const Indexlist& rhs    
                                        );

                ~Indexlist( );

                Indexlist& operator=(   const Indexlist& rhs    
                                                                );


                returnValue init(       int_t n = 0     
                                                        );


                returnValue     getNumberArray( int_t** const numberarray       
                                                                        ) const;

                returnValue     getISortArray(  int_t** const iSortArray        
                                                                        ) const;


                int_t getIndex( int_t givennumber       
                                                ) const;

                int_t getNumber(        int_t physicalindex     
                                                        ) const;


                inline int_t getLength( ) const;

                inline int_t getLastNumber( ) const;


                returnValue addNumber(  int_t addnumber                 
                                                                );

                returnValue removeNumber(       int_t removenumber      
                                                                        );

                returnValue swapNumbers(        int_t number1,          
                                                                        int_t number2                   
                                                                        );

                inline BooleanType isMember(    int_t _number           
                                                                                ) const;


        /*
         *      PROTECTED MEMBER FUNCTIONS
         */
        protected:
                returnValue clear( );

                returnValue copy(       const Indexlist& rhs    
                                                        );

                int_t findInsert(       int_t i
                                                        ) const;


        /*
         *      PROTECTED MEMBER VARIABLES
         */
        protected:
                int_t* number;                  
                int_t* iSort;                   
                int_t   length;                 
                int_t   first;                  
                int_t   last;                   
                int_t   lastusedindex;  
                int_t   physicallength; 
};

END_NAMESPACE_QPOASES

#include <qpOASES/Indexlist.ipp>

#endif  /* QPOASES_INDEXLIST_HPP */


/*
 *      end of file
 */