Crocoddyl
 
Loading...
Searching...
No Matches
fwd.hpp
1
2// BSD 3-Clause License
3//
4// Copyright (C) 2019-2025, LAAS-CNRS, University of Edinburgh,
5// Heriot-Watt University
6// Copyright note valid unless otherwise stated in individual files.
7// All rights reserved.
9
10#ifndef CROCODDYL_CORE_FWD_HPP_
11#define CROCODDYL_CORE_FWD_HPP_
12
13#include "crocoddyl/core/pch.hpp"
14
15namespace crocoddyl {
16
17inline bool& enableMultithreading() {
18 static bool enable = true;
19 return enable;
20}
21
22enum AssignmentOp { setto, addto, rmfrom };
23
24inline bool is_a_AssignmentOp(AssignmentOp op) {
25 return (op == setto || op == addto || op == rmfrom);
26}
27
28// action
29template <typename Scalar>
30class ActionModelAbstractTpl;
31
32template <typename Scalar>
33struct ActionDataAbstractTpl;
34
35template <typename Scalar>
36class ActionModelUnicycleTpl;
37template <typename Scalar>
38struct ActionDataUnicycleTpl;
39
40template <typename Scalar>
41class ActionModelLQRTpl;
42template <typename Scalar>
43struct ActionDataLQRTpl;
44
45// differential action
46template <typename Scalar>
47class DifferentialActionModelAbstractTpl;
48template <typename Scalar>
49struct DifferentialActionDataAbstractTpl;
50
51template <typename Scalar>
52class DifferentialActionModelLQRTpl;
53template <typename Scalar>
54struct DifferentialActionDataLQRTpl;
55
56// integrated action
57template <typename Scalar>
58class IntegratedActionModelAbstractTpl;
59template <typename Scalar>
60struct IntegratedActionDataAbstractTpl;
61
62template <typename Scalar>
63class IntegratedActionModelEulerTpl;
64template <typename Scalar>
65struct IntegratedActionDataEulerTpl;
66
67template <typename Scalar>
68class IntegratedActionModelRKTpl;
69template <typename Scalar>
70struct IntegratedActionDataRKTpl;
71
72// residual
73template <typename Scalar>
74class ResidualModelAbstractTpl;
75template <typename Scalar>
76struct ResidualDataAbstractTpl;
77
78// activation
79template <typename Scalar>
80struct ActivationBoundsTpl;
81template <typename Scalar>
82class ActivationModelQuadraticBarrierTpl;
83template <typename Scalar>
84struct ActivationDataQuadraticBarrierTpl;
85
86template <typename Scalar>
87class ActivationModelWeightedQuadraticBarrierTpl;
88
89template <typename Scalar>
90class ActivationModelQuadTpl;
91
92template <typename Scalar>
93class ActivationModelQuadFlatExpTpl;
94template <typename Scalar>
95struct ActivationDataQuadFlatExpTpl;
96
97template <typename Scalar>
98class ActivationModelQuadFlatLogTpl;
99template <typename Scalar>
100struct ActivationDataQuadFlatLogTpl;
101
102template <typename Scalar>
103class ActivationModelWeightedQuadTpl;
104template <typename Scalar>
105struct ActivationDataWeightedQuadTpl;
106
107template <typename Scalar>
108class ActivationModelSmooth1NormTpl;
109template <typename Scalar>
110struct ActivationDataSmooth1NormTpl;
111
112template <typename Scalar>
113class ActivationModelSmooth2NormTpl;
114template <typename Scalar>
115struct ActivationDataSmooth2NormTpl;
116
117template <typename Scalar>
118class ActivationModel2NormBarrierTpl;
119template <typename Scalar>
120struct ActivationData2NormBarrierTpl;
121
122template <typename Scalar>
123class ActivationModelAbstractTpl;
124template <typename Scalar>
125struct ActivationDataAbstractTpl;
126
127// state
128template <typename Scalar>
129class StateAbstractTpl;
130
131template <typename Scalar>
132class StateVectorTpl;
133
134// control
135template <typename Scalar>
136class ControlParametrizationModelAbstractTpl;
137template <typename Scalar>
138struct ControlParametrizationDataAbstractTpl;
139
140template <typename Scalar>
141class ControlParametrizationModelPolyZeroTpl;
142
143template <typename Scalar>
144class ControlParametrizationModelPolyOneTpl;
145template <typename Scalar>
146struct ControlParametrizationDataPolyOneTpl;
147
148template <typename Scalar>
149class ControlParametrizationModelPolyTwoRKTpl;
150template <typename Scalar>
151struct ControlParametrizationDataPolyTwoRKTpl;
152
153// actuation
154template <typename Scalar>
155class ActuationModelAbstractTpl;
156template <typename Scalar>
157struct ActuationDataAbstractTpl;
158
159template <typename Scalar>
160class ActuationSquashingModelTpl;
161template <typename Scalar>
162struct ActuationSquashingDataTpl;
163
164// squashing
165template <typename Scalar>
166class SquashingModelAbstractTpl;
167template <typename Scalar>
168struct SquashingDataAbstractTpl;
169
170template <typename Scalar>
171class SquashingModelSmoothSatTpl;
172
173// joint
174template <typename Scalar>
175struct JointDataAbstractTpl;
176
177// data collector
178template <typename Scalar>
179struct DataCollectorAbstractTpl;
180
181template <typename Scalar>
182struct DataCollectorActuationTpl;
183
184template <typename Scalar>
185struct DataCollectorJointTpl;
186
187template <typename Scalar>
188struct DataCollectorJointActuationTpl;
189
190// residual
191template <typename Scalar>
192class ResidualModelControlTpl;
193template <typename Scalar>
194struct ResidualDataControlTpl;
195
196template <typename Scalar>
197class ResidualModelJointEffortTpl;
198template <typename Scalar>
199struct ResidualDataJointEffortTpl;
200
201template <typename Scalar>
202class ResidualModelJointAccelerationTpl;
203template <typename Scalar>
204struct ResidualDataJointAccelerationTpl;
205
206// cost
207template <typename Scalar>
208class CostModelAbstractTpl;
209template <typename Scalar>
210struct CostDataAbstractTpl;
211
212template <typename Scalar>
213struct CostItemTpl;
214template <typename Scalar>
215class CostModelSumTpl;
216template <typename Scalar>
217struct CostDataSumTpl;
218
219template <typename Scalar>
220class CostModelResidualTpl;
221template <typename Scalar>
222struct CostDataResidualTpl;
223
224// constraint
225template <typename Scalar>
226class ConstraintModelAbstractTpl;
227template <typename Scalar>
228struct ConstraintDataAbstractTpl;
229
230template <typename Scalar>
231struct ConstraintItemTpl;
232template <typename Scalar>
233class ConstraintModelManagerTpl;
234template <typename Scalar>
235struct ConstraintDataManagerTpl;
236
237template <typename Scalar>
238class ConstraintModelResidualTpl;
239template <typename Scalar>
240struct ConstraintDataResidualTpl;
241
242// shooting
243template <typename Scalar>
244class ShootingProblemTpl;
245
246// Numdiff
247template <typename Scalar>
248class ActionModelNumDiffTpl;
249template <typename Scalar>
250struct ActionDataNumDiffTpl;
251
252template <typename Scalar>
253class DifferentialActionModelNumDiffTpl;
254template <typename Scalar>
255struct DifferentialActionDataNumDiffTpl;
256
257template <typename Scalar>
258class ActuationModelNumDiffTpl;
259template <typename Scalar>
260struct ActuationDataNumDiffTpl;
261
262template <typename Scalar>
263class ActivationModelNumDiffTpl;
264template <typename Scalar>
265struct ActivationDataNumDiffTpl;
266
267template <typename Scalar>
268class ResidualModelNumDiffTpl;
269template <typename Scalar>
270struct ResidualDataNumDiffTpl;
271
272template <typename Scalar>
273class ConstraintModelNumDiffTpl;
274template <typename Scalar>
275struct ConstraintDataNumDiffTpl;
276
277template <typename Scalar>
278class StateNumDiffTpl;
279
280template <typename Scalar>
281class ControlParametrizationModelNumDiffTpl;
282template <typename Scalar>
283struct ControlParametrizationDataNumDiffTpl;
284
285template <typename Scalar>
286class ActuationModelNumDiffTpl;
287template <typename Scalar>
288struct ActuationDataNumDiffTpl;
289
290template <typename Scalar>
291class ActionModelCodeGenTpl;
292
293template <typename Scalar>
294struct ActionDataCodeGenTpl;
295
296/********************Template Instantiation*************/
297typedef ActionModelAbstractTpl<double> ActionModelAbstract;
298typedef ActionDataAbstractTpl<double> ActionDataAbstract;
299typedef ActionModelUnicycleTpl<double> ActionModelUnicycle;
300typedef ActionDataUnicycleTpl<double> ActionDataUnicycle;
301typedef ActionModelLQRTpl<double> ActionModelLQR;
302typedef ActionDataLQRTpl<double> ActionDataLQR;
303
304typedef DifferentialActionModelAbstractTpl<double>
305 DifferentialActionModelAbstract;
306typedef DifferentialActionDataAbstractTpl<double>
307 DifferentialActionDataAbstract;
308typedef DifferentialActionModelLQRTpl<double> DifferentialActionModelLQR;
309typedef DifferentialActionDataLQRTpl<double> DifferentialActionDataLQR;
310
311typedef IntegratedActionModelAbstractTpl<double> IntegratedActionModelAbstract;
312typedef IntegratedActionDataAbstractTpl<double> IntegratedActionDataAbstract;
313typedef IntegratedActionModelEulerTpl<double> IntegratedActionModelEuler;
314typedef IntegratedActionDataEulerTpl<double> IntegratedActionDataEuler;
315typedef IntegratedActionModelRKTpl<double> IntegratedActionModelRK;
316typedef IntegratedActionDataRKTpl<double> IntegratedActionDataRK;
317
318typedef ResidualModelAbstractTpl<double> ResidualModelAbstract;
319typedef ResidualDataAbstractTpl<double> ResidualDataAbstract;
320typedef ResidualModelControlTpl<double> ResidualModelControl;
321typedef ResidualDataControlTpl<double> ResidualDataControl;
322typedef ResidualModelJointEffortTpl<double> ResidualModelJointEffort;
323typedef ResidualDataJointEffortTpl<double> ResidualDataJointEffort;
324typedef ResidualModelJointAccelerationTpl<double>
325 ResidualModelJointAcceleration;
326typedef ResidualDataJointAccelerationTpl<double> ResidualDataJointAcceleration;
327
328typedef ActivationDataQuadraticBarrierTpl<double>
329 ActivationDataQuadraticBarrier;
330typedef ActivationModelQuadraticBarrierTpl<double>
331 ActivationModelQuadraticBarrier;
332typedef ActivationBoundsTpl<double> ActivationBounds;
333typedef ActivationModelWeightedQuadraticBarrierTpl<double>
334 ActivationModelWeightedQuadraticBarrier;
335typedef ActivationModelQuadTpl<double> ActivationModelQuad;
336typedef ActivationModelQuadFlatExpTpl<double> ActivationModelQuadFlatExp;
337typedef ActivationDataQuadFlatExpTpl<double> ActivationDataQuadFlatExp;
338typedef ActivationModelQuadFlatLogTpl<double> ActivationModelQuadFlatLog;
339typedef ActivationDataQuadFlatLogTpl<double> ActivationDataQuadFlatLog;
340typedef ActivationModelWeightedQuadTpl<double> ActivationModelWeightedQuad;
341typedef ActivationDataWeightedQuadTpl<double> ActivationDataWeightedQuad;
342DEPRECATED(
343 "Use ActivationModelSmooth1Norm",
344 typedef ActivationModelSmooth1NormTpl<double> ActivationModelSmoothAbs;)
345DEPRECATED(
346 "Use ActivationDataSmooth1Norm",
347 typedef ActivationDataSmooth1NormTpl<double> ActivationDataSmoothAbs;)
348typedef ActivationModelSmooth1NormTpl<double> ActivationModelSmooth1Norm;
349typedef ActivationDataSmooth1NormTpl<double> ActivationDataSmooth1Norm;
350typedef ActivationModelSmooth2NormTpl<double> ActivationModelSmooth2Norm;
351typedef ActivationDataSmooth2NormTpl<double> ActivationDataSmooth2Norm;
352typedef ActivationModel2NormBarrierTpl<double> ActivationModel2NormBarrier;
353typedef ActivationData2NormBarrierTpl<double> ActivationData2NormBarrier;
354typedef ActivationModelAbstractTpl<double> ActivationModelAbstract;
355typedef ActivationDataAbstractTpl<double> ActivationDataAbstract;
356
357typedef StateAbstractTpl<double> StateAbstract;
358typedef StateVectorTpl<double> StateVector;
359
360typedef ControlParametrizationModelAbstractTpl<double>
361 ControlParametrizationModelAbstract;
362typedef ControlParametrizationDataAbstractTpl<double>
363 ControlParametrizationDataAbstract;
364typedef ControlParametrizationModelPolyZeroTpl<double>
365 ControlParametrizationModelPolyZero;
366typedef ControlParametrizationModelPolyOneTpl<double>
367 ControlParametrizationModelPolyOne;
368typedef ControlParametrizationDataPolyOneTpl<double>
369 ControlParametrizationDataPolyOne;
370typedef ControlParametrizationModelPolyTwoRKTpl<double>
371 ControlParametrizationModelPolyTwoRK;
372typedef ControlParametrizationDataPolyTwoRKTpl<double>
373 ControlParametrizationDataPolyTwoRK;
374
375typedef ActuationDataAbstractTpl<double> ActuationDataAbstract;
376typedef ActuationModelAbstractTpl<double> ActuationModelAbstract;
377typedef ActuationSquashingDataTpl<double> ActuationSquashingData;
378typedef ActuationSquashingModelTpl<double> ActuationSquashingModel;
379
380typedef SquashingDataAbstractTpl<double> SquashingDataAbstract;
381typedef SquashingModelAbstractTpl<double> SquashingModelAbstract;
382typedef SquashingModelSmoothSatTpl<double> SquashingModelSmoothSat;
383
384typedef JointDataAbstractTpl<double> JointDataAbstract;
385
386typedef DataCollectorAbstractTpl<double> DataCollectorAbstract;
387typedef DataCollectorActuationTpl<double> DataCollectorActuation;
388typedef DataCollectorJointTpl<double> DataCollectorJoint;
389typedef DataCollectorJointActuationTpl<double> DataCollectorJointActuation;
390
391typedef CostModelAbstractTpl<double> CostModelAbstract;
392typedef CostDataAbstractTpl<double> CostDataAbstract;
393typedef CostItemTpl<double> CostItem;
394typedef CostModelSumTpl<double> CostModelSum;
395typedef CostDataSumTpl<double> CostDataSum;
396typedef CostModelResidualTpl<double> CostModelResidual;
397typedef CostDataResidualTpl<double> CostDataResidual;
398
399typedef ConstraintModelAbstractTpl<double> ConstraintModelAbstract;
400typedef ConstraintDataAbstractTpl<double> ConstraintDataAbstract;
401typedef ConstraintItemTpl<double> ConstraintItem;
402typedef ConstraintModelManagerTpl<double> ConstraintModelManager;
403typedef ConstraintDataManagerTpl<double> ConstraintDataManager;
404typedef ConstraintModelResidualTpl<double> ConstraintModelResidual;
405typedef ConstraintDataResidualTpl<double> ConstraintDataResidual;
406
407typedef ShootingProblemTpl<double> ShootingProblem;
408
409typedef ActionModelNumDiffTpl<double> ActionModelNumDiff;
410typedef ActionDataNumDiffTpl<double> ActionDataNumDiff;
411typedef ControlParametrizationModelNumDiffTpl<double>
412 ControlParametrizationModelNumDiff;
413typedef ControlParametrizationDataNumDiffTpl<double>
414 ControlParametrizationDataNumDiff;
415typedef DifferentialActionModelNumDiffTpl<double>
416 DifferentialActionModelNumDiff;
417typedef ActuationModelNumDiffTpl<double> ActuationModelNumDiff;
418typedef ActuationDataNumDiffTpl<double> ActuationDataNumDiff;
419typedef DifferentialActionDataNumDiffTpl<double> DifferentialActionDataNumDiff;
420typedef ActivationModelNumDiffTpl<double> ActivationModelNumDiff;
421typedef ActivationDataNumDiffTpl<double> ActivationDataNumDiff;
422typedef ResidualModelNumDiffTpl<double> ResidualModelNumDiff;
423typedef ResidualDataNumDiffTpl<double> ResidualDataNumDiff;
424typedef ConstraintModelNumDiffTpl<double> ConstraintModelNumDiff;
425typedef ConstraintDataNumDiffTpl<double> ConstraintDataNumDiff;
426typedef StateNumDiffTpl<double> StateNumDiff;
427typedef ActuationModelNumDiffTpl<double> ActuationModelNumDiff;
428typedef ActuationDataNumDiffTpl<double> ActuationDataNumDiff;
429
430typedef ActionModelCodeGenTpl<double> ActionModelCodeGen;
431typedef ActionDataCodeGenTpl<double> ActionDataCodeGen;
432
433} // namespace crocoddyl
434
435#endif // CROCODDYL_CORE_FWD_HPP_
crocoddyl::ActionModelAbstractTpl
Abstract class for action model.
Definition action-base.hpp:97
crocoddyl::ActionModelLQRTpl
Linear-quadratic regulator (LQR) action model.
Definition lqr.hpp:45
crocoddyl::ActionModelNumDiffTpl
This class computes the numerical differentiation of an action model.
Definition action.hpp:44
crocoddyl::ActuationModelAbstractTpl
Abstract class for the actuation-mapping model.
Definition actuation-base.hpp:46
crocoddyl::ActuationModelNumDiffTpl
This class computes the numerical differentiation of an actuation model.
Definition actuation.hpp:31
crocoddyl::ConstraintModelAbstractTpl
Abstract class for constraint models.
Definition constraint-base.hpp:54
crocoddyl::ConstraintModelManagerTpl
Manage the individual constraint models.
Definition constraint-manager.hpp:69
crocoddyl::ConstraintModelNumDiffTpl
This class computes the numerical differentiation of a constraint model.
Definition constraint.hpp:30
crocoddyl::ConstraintModelResidualTpl
Residual-based constraint.
Definition residual.hpp:47
crocoddyl::ControlParametrizationModelAbstractTpl
Abstract class for the control trajectory parametrization.
Definition control-base.hpp:49
crocoddyl::ControlParametrizationModelPolyOneTpl
A polynomial function of time of degree one, that is a linear function.
Definition poly-one.hpp:42
crocoddyl::ControlParametrizationModelPolyTwoRKTpl
A polynomial function of time of degree two, that is a quadratic function.
Definition poly-two-rk.hpp:51
crocoddyl::ControlParametrizationModelPolyZeroTpl
A polynomial function of time of degree zero, that is a constant.
Definition poly-zero.hpp:37
crocoddyl::CostModelAbstractTpl
Abstract class for cost models.
Definition cost-base.hpp:64
crocoddyl::CostModelResidualTpl
Residual-based cost.
Definition residual.hpp:39
crocoddyl::CostModelSumTpl
Summation of individual cost models.
Definition cost-sum.hpp:75
crocoddyl::DifferentialActionModelAbstractTpl
Abstract class for differential action model.
Definition diff-action-base.hpp:122
crocoddyl::DifferentialActionModelLQRTpl
Linear-quadratic regulator (LQR) differential action model.
Definition diff-lqr.hpp:46
crocoddyl::DifferentialActionModelNumDiffTpl
This class computes the numerical differentiation of a differential action model.
Definition diff-action.hpp:45
crocoddyl::IntegratedActionModelAbstractTpl
Abstract class for an integrated action model.
Definition integ-action-base.hpp:42
crocoddyl::IntegratedActionModelEulerTpl
Symplectic Euler integrator.
Definition euler.hpp:38
crocoddyl::IntegratedActionModelRKTpl
Standard RK integrator.
Definition rk.hpp:40
crocoddyl::ResidualModelAbstractTpl
Abstract class for residual models.
Definition residual-base.hpp:48
crocoddyl::ResidualModelControlTpl
Define a control residual.
Definition control.hpp:35
crocoddyl::ResidualModelJointAccelerationTpl
Define a joint-acceleration residual.
Definition joint-acceleration.hpp:38
crocoddyl::ResidualModelJointEffortTpl
Define a joint-effort residual.
Definition joint-effort.hpp:36
crocoddyl::ResidualModelNumDiffTpl
This class computes the numerical differentiation of a residual model.
Definition residual.hpp:29
crocoddyl::ShootingProblemTpl
This class encapsulates a shooting problem.
Definition shooting.hpp:32
crocoddyl::StateAbstractTpl
Abstract class for the state representation.
Definition state-base.hpp:48