File: fwd.hh

package info (click to toggle)
roboptim-core 2.0-7
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,488 kB
  • ctags: 1,160
  • sloc: cpp: 5,388; sh: 395; ansic: 387; makefile: 25; python: 19
file content (120 lines) | stat: -rw-r--r-- 3,673 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright (C) 2009 by Thomas Moulard, AIST, CNRS, INRIA.
//
// This file is part of the roboptim.
//
// roboptim 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 3 of the License, or
// (at your option) any later version.
//
// roboptim 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 roboptim.  If not, see <http://www.gnu.org/licenses/>.

#ifndef ROBOPTIM_CORE_FWD_HH
# define ROBOPTIM_CORE_FWD_HH

namespace roboptim
{
  /// \brief Tag a result if no solution has been found.
  ///
  /// Returned by GenericSolver::getMinimum if no solution can be
  /// found (but no error has been encountered during the process).
  /// It usually means that the solver has not been called to solve
  /// the problem.
  class NoSolution {};

  class ConstantFunction;

  template <typename T>
  class GenericDifferentiableFunction;

  class DummySolver;

  namespace finiteDifferenceGradientPolicies
  {
    template <typename T>
    class Simple;
    template <typename T>
    class FivePointsRule;
  } // end of finiteDifferenceGradientPolicies

  template <typename T,
	    typename FdgPolicy =
	    finiteDifferenceGradientPolicies::FivePointsRule<T> >
  class GenericFiniteDifferenceGradient;

  template <typename T>
  class GenericFunction;

  template <typename T>
  struct GenericFunctionTraits;

  /// \brief Tag type for functions using Eigen dense matrices.
  struct EigenMatrixDense {};
  /// \brief Tag type for functions using Eigen sparse matrices.
  struct EigenMatrixSparse {};

  /// \brief Dense function.
  typedef GenericFunction<EigenMatrixDense>
  Function;

  /// \brief Sparse function.
  typedef GenericFunction<EigenMatrixSparse>
  SparseFunction;

  /// \brief Dense differentiable function.
  typedef GenericDifferentiableFunction<EigenMatrixDense>
  DifferentiableFunction;

  /// \brief Sparse differentiable function.
  typedef GenericDifferentiableFunction<EigenMatrixSparse>
  DifferentiableSparseFunction;


  class GenericSolver;
  class NoSolution;

  template <typename T>
  class GenericNumericLinearFunction;
  typedef GenericNumericLinearFunction<EigenMatrixDense>
  NumericLinearFunction;

  class NumericQuadraticFunction;
  class Result;
  class ResultWithWarnings;
  class SolverError;
  class SolverWarning;

  template <typename T>
  class GenericTwiceDifferentiableFunction;
  typedef GenericTwiceDifferentiableFunction<EigenMatrixDense>
  TwiceDifferentiableFunction;
  typedef GenericTwiceDifferentiableFunction<EigenMatrixSparse>
  TwiceDifferentiableSparseFunction;

  template <typename T>
  class GenericLinearFunction;
  typedef GenericLinearFunction<EigenMatrixDense> LinearFunction;
  typedef GenericLinearFunction<EigenMatrixSparse> LinearSparseFunction;

  template <typename T>
  class GenericQuadraticFunction;
  typedef GenericQuadraticFunction<EigenMatrixDense> QuadraticFunction;
  typedef GenericQuadraticFunction<EigenMatrixSparse> QuadraticSparseFunction;

  template <typename F, typename C = F> class Problem;
  template <typename F, typename C = F> class Solver;
  template <typename T> class SolverFactory;
  template <unsigned DerivabilityOrder> class NTimesDerivableFunction;

  template <typename T>
  struct derivativeSize;

} // end of namespace roboptim.

#endif //! ROBOPTIM_CORE_FWD_HH