PlaneGCSSolver_Solver.h

// Copyright (C) 2014-2025  CEA, EDF
//
// 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef PlaneGCSSolver_Solver_H_
#define PlaneGCSSolver_Solver_H_
 
#include <PlaneGCSSolver_Defs.h>
#include <PlaneGCSSolver_ConstraintWrapper.h>
 
#include <GCS.h>
 
class PlaneGCSSolver_Solver
{
public:
  enum SolveStatus {
    STATUS_OK,
    STATUS_INCONSISTENT,
    STATUS_EMPTYSET,
    STATUS_DEGENERATED,
    STATUS_FAILED, // set if no one other status is applicable
    STATUS_UNKNOWN // set for newly created groups
  };
 
  PlaneGCSSolver_Solver();
  ~PlaneGCSSolver_Solver();
 
  void clear();
 
  void addConstraint(const ConstraintID& theMultiConstraintID,
                     const std::list<GCSConstraintPtr>& theConstraints);
 
  void removeConstraint(const ConstraintID& theID);
 
  double* createParameter();
  void addParameters(const GCS::SET_pD& theParams);
  void removeParameters(const GCS::SET_pD& theParams);
 
  void initialize();
 
  SolveStatus solve();
 
  void undo();
 
  bool isConflicting(const ConstraintID& theConstraint) const;
 
  void diagnose(const GCS::Algorithm& theAlgo = GCS::DogLeg);
 
  void getFreeParameters(GCS::SET_pD& theFreeParams);
 
  int dof();
 
private:
  void collectConflicting(bool withRedundant = true);
 
  void addFictiveConstraintIfNecessary();
  void removeFictiveConstraint();
 
private:
  typedef std::map<ConstraintID, std::list<GCSConstraintPtr> > ConstraintMap;
 
  GCS::VEC_pD                  myParameters;     
  ConstraintMap                myConstraints;    
 
  std::shared_ptr<GCS::System> myEquationSystem; 
  bool                         myDiagnoseBeforeSolve; 
  bool                         myInitilized;     
 
  GCS::SET_I                   myConflictingIDs; 
  bool                         myConfCollected;
 
  int                          myDOF;            
 
  GCS::Constraint*             myFictiveConstraint;
};
 
typedef std::shared_ptr<PlaneGCSSolver_Solver> SolverPtr;
 
#endif