IpFilter.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2006 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13
 
#ifndef __IPFILTER_HPP__
#define __IPFILTER_HPP__
 
#include "IpJournalist.hpp"
#include "IpDebug.hpp"
#include <list>
#include <vector>
 
namespace Ipopt
{
 
class FilterEntry
{
public:
 
   FilterEntry(
      const std::vector<Number>& vals,
      Index                      iter
   );
 
   ~FilterEntry();
 
   bool Acceptable(
      std::vector<Number> vals
   ) const
   {
      Index ncoor = (Index) vals_.size();
      DBG_ASSERT((Index)vals.size() == ncoor);
 
      // ToDo decide if we need Compare_le
      bool retval = false;
      for( Index i = 0; i < ncoor; i++ )
      {
         if( vals[i] <= vals_[i] )
         {
            retval = true;
            break;
         }
      }
 
      return retval;
   }
 
   bool Dominated(
      std::vector<Number> vals
   ) const
   {
      Index ncoor = (Index) vals_.size();
      DBG_ASSERT((Index)vals.size() == ncoor);
 
      bool retval = true;
      for( Index i = 0; i < ncoor; i++ )
      {
         if( vals[i] > vals_[i] )
         {
            retval = false;
            break;
         }
      }
 
      return retval;
   }
 
   Number val(
      Index i
   ) const
   {
      return vals_[i];
   }
   Index iter() const
   {
      return iter_;
   }
 
private:
 
   FilterEntry();
   FilterEntry(
      const FilterEntry&
   );
 
   void operator=(
      const FilterEntry&
   );
 
   std::vector<Number> vals_;
   const Index iter_;
};
 
class Filter
{
public:
 
   Filter(
      Index dim
   );
   ~Filter()
   {
      //ToDo figure out if that here is necessary
      Clear();
   }
 
   bool Acceptable(
      std::vector<Number> vals
   ) const;
 
   void AddEntry(
      std::vector<Number> vals,
      Index               iteration
   );
 
   bool Acceptable(
      Number val1,
      Number val2
   ) const
   {
      std::vector<Number> vals(2);
      vals[0] = val1;
      vals[1] = val2;
 
      return Acceptable(vals);
   }
 
   void AddEntry(
      Number val1,
      Number val2,
      Index  iteration
   )
   {
      std::vector<Number> vals(2);
      vals[0] = val1;
      vals[1] = val2;
 
      AddEntry(vals, iteration);
   }
 
   void Clear();
 
   void Print(
      const Journalist& jnlst
   );
 
private:
 
   Filter();
   Filter(
      const Filter&
   );
 
   void operator=(
      const Filter&
   );
 
   Index dim_;
 
   mutable std::list<FilterEntry*> filter_list_;
};
 
} // namespace Ipopt
 
#endif