DART  6.10.1
BoxedLcpSolver.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_CONSTRAINT_BOXEDLCPSOLVER_HPP_
34 #define DART_CONSTRAINT_BOXEDLCPSOLVER_HPP_
35 
36 #include <string>
37 #include <Eigen/Core>
38 
39 namespace dart {
40 namespace constraint {
41 
43 {
44 public:
46  virtual ~BoxedLcpSolver() = default;
47 
49  virtual const std::string& getType() const = 0;
50 
64  template <typename BoxedLcpSolverT>
65  bool is() const;
66 
90  // Note: The function signature is ODE specific for now. Consider changing
91  // this to Eigen friendly version once own Dantzig LCP solver is available.
92  virtual bool solve(
93  int n,
94  double* A,
95  double* x,
96  double* b,
97  int nub,
98  double* lo,
99  double* hi,
100  int* findex,
101  bool earlyTermination = false)
102  = 0;
103 
104 #ifndef NDEBUG
105  virtual bool canSolve(int n, const double* A) = 0;
106 #endif
107 };
108 
109 } // namespace constraint
110 } // namespace dart
111 
113 
114 #endif // DART_CONSTRAINT_BOXEDLCPSOLVER_HPP_
Definition: BoxedLcpSolver.hpp:43
virtual ~BoxedLcpSolver()=default
Destructor.
virtual const std::string & getType() const =0
Returns the type.
bool is() const
Returns true if this solver and the template parameter (a solver class) are the same type.
Definition: BoxedLcpSolver-impl.hpp:42
virtual bool canSolve(int n, const double *A)=0
virtual bool solve(int n, double *A, double *x, double *b, int nub, double *lo, double *hi, int *findex, bool earlyTermination=false)=0
Solves constriant impulses for a constrained group.
Definition: BulletCollisionDetector.cpp:65