Drake
 All Classes Files Functions Variables
KinematicDirtran Class Reference

Trajectory planning problem in which the acceleration of the joints is taken to be directly controllable. More...

Inheritance diagram for KinematicDirtran:
Collaboration diagram for KinematicDirtran:

Public Member Functions

function KinematicDirtran (robot, N, duration, options)
 corresponding to the velocities at each knot point. More...
 
function addConstraint (obj, constraint, varargin)
 
function solveTraj (obj, t_init, q_traj_init)
 
- Public Member Functions inherited from KinematicTrajectoryOptimization
virtual function addConstraint (cnstr, xind)
 
virtual function addSharedDataFunction (fun, xind)
 
virtual function addDecisionVariable (num_var, names)
 
virtual function getN (obj)
 
virtual function getXinds (obj)
 
virtual function getHinds (obj)
 
function KinematicTrajectoryOptimization (robot, initialize_flag)
 
function initialize (obj)
 
function kinematicsData (obj, q)
 
function addKinematicConstraint (obj, constraint, time_index)
 Add a kinematic constraint that is a function of the joint positions at the specified time or times. More...
 
function addRigidBodyConstraint (obj, constraint, time_index)
 Add a kinematic constraint that is a function of the state at the specified time or times. More...
 
- Public Member Functions inherited from DirtranTrajectoryOptimization
function DirtranTrajectoryOptimization (plant, N, duration, options)
 
function addDynamicConstraints (obj)
 
function addRunningCost (obj, running_cost_function)
 Adds an integrated cost to all time steps, which is numerical implementation specific (thus abstract) this cost is assumed to be time-invariant. More...
 
- Public Member Functions inherited from DirectTrajectoryOptimization
function DirectTrajectoryOptimization (plant, N, durations, options)
 function obj = DirectTrajectoryOptimization(plant,initial_cost,running_cost,final_cost, % t_init,traj_init,T_span,constraints, options) Trajectory optimization constructor More...
 
function getN (obj)
 
function getXinds (obj)
 
function getHinds (obj)
 
function addInputConstraint (obj, constraint, time_index)
 Add constraint (or composite constraint) that is a function of the input at the specified time or times. More...
 
function addStateConstraint (obj, constraint, time_index, x_indices)
 Add constraint (or composite constraint) that is a function of the state at the specified time or times. More...
 
function addTrajectoryDisplayFunction (obj, display_fun)
 add a dispay function that gets called on every iteration of the algorithm More...
 
function solveTraj (obj, t_init, traj_init)
 Solve the nonlinear program and return resulting trajectory. More...
 
function getInitialVars (obj, t_init, traj_init)
 evaluates the initial trajectories at the sampled times and constructs the nominal z0. More...
 
function setupVariables (obj, N)
 Default implementation, Assumes, if time is not fixed, that there are N-1 time steps N corresponding state variables and N-1 corresponding input variables Overwrite to change. More...
 
function addInitialCost (obj, initial_cost)
 Adds a cost to the initial state f(x0) More...
 
function addFinalCost (obj, final_cost_function)
 adds a cost to the final state and total time More...
 
function reconstructInputTrajectory (obj, z)
 default behavior is to use first order holds, but this can be re-implemented by a subclass. More...
 
function reconstructStateTrajectory (obj, z)
 default behavior is to use first order holds, but this can be re-implemented by a subclass. More...
 
function extractFirstInput (obj, z)
 When using trajectory optimization a part of a model-predictive control system, we often only need to extract u(0). More...
 
- Public Member Functions inherited from NonlinearProgram
function NonlinearProgram (num_vars, x_name)
 
function addCompositeConstraints (obj, cnstr, xind, data_ind)
 add a CompositeConstraint to the object, change the constraint evalation of the program. More...
 
function addConstraint (obj, cnstr, varargin)
 obj = addConstraint(obj,cnstr,varargin) Queries the constraint type and calls the appropriate addConstraint method (e.g. More...
 
function addNonlinearConstraint (obj, cnstr, xind, data_ind)
 add a NonlinearConstraint to the object, change the constraint evalation of the program. More...
 
function addLinearConstraint (obj, cnstr, xind)
 add a LinearConstraint to the program More...
 
function addBoundingBoxConstraint (obj, cnstr, xind)
 add a BoundingBoxConstraint to the program More...
 
function addCost (obj, cnstr, xind, data_ind)
 Add a cost to the objective function. More...
 
function addQuadraticCost (obj, Q, x_desired, xind)
 helper function for the very common case of adding the objective g(x) = (x-xd)'Q(x-xd), Q = Q' >= 0 More...
 
function getArgumentArray (obj, x, xind)
 Retrieves the elements from the vector x related to xind and returns them as a cell array where: args{i} = x(xind{i}) More...
 
function nonlinearConstraints (obj, x)
 evaluate the nonlinear constraints More...
 
function objective (obj, x)
 return the value of the objective More...
 
function objectiveAndNonlinearConstraints (obj, x)
 evaluate the objective and the nonlinear constraints altogher More...
 
function addDecisionVariable (obj, num_new_vars, var_name)
 appending new decision variables to the end of the current decision variables More...
 
function replaceCost (obj, cost, cost_idx, xind)
 replace the cost_idx'th cost in the original problem with a new cost More...
 
function addSharedDataFunction (obj, user_fun, xind)
 Adds the specified shared data function to be evaluated within each iteration of the program. More...
 
function getNumSharedDataFunctions (obj)
 
function evaluateSharedDataFunctions (obj, x)
 Evaluate all shared data functions and return the data object. More...
 
function addDisplayFunction (obj, display_fun, indices)
 add a dispay function that gets called on every iteration of the algorithm More...
 
function setCheckGrad (obj, check_grad)
 
function setConstraintErrTol (obj, tol)
 
function setSolver (obj, solver)
 
function setSolverOptions (obj, solver, optionname, optionval)
 
function getNonlinearGradientSparsity (obj)
 This function sets the nonlinear sparsity vector iGfun and jGvar based on the nonlinear sparsity of the objective, nonlinear inequality constraints and nonlinear equality constraints. More...
 
function bounds (obj)
 return the bounds for all the objective function, nonlinear constraints and linear constraints More...
 
function solve (obj, x0)
 
function compareSolvers (obj, x0, solvers)
 
function isNonlinearConstraintID (obj, cnstr_id)
 Given an ID, determine if any of the nonlinear constraint obj.nlcon has that ID. More...
 
function isLinearConstraintID (obj, cnstr_id)
 Given an ID, determine if any of the linear constraint obj.lcon has that ID. More...
 
function isBoundingBoxConstraintID (obj, cnstr_id)
 Given an ID, determine if any of the bounding box constraint obj.bbcon has that ID. More...
 
function deleteConstraint (obj, delete_cnstr_id)
 delete a constraint from the program More...
 
function updateConstraint (obj, varargin)
 update a Constraint of the program. More...
 
function deleteNonlinearConstraint (obj, delete_cnstr_id)
 delete a nonlinear constraint from the program More...
 
function updateNonlinearConstraint (obj, varargin)
 updateNonlinearConstraint(obj,cnstr_id,cnstr,xind,data_ind) update the nonlinear constraint whose id=cnstr_id with a new Constraint object cnstr, the newly added Constraint cnstr has the ID new_cnstr_id More...
 
function deleteLinearConstraint (obj, delete_cnstr_id)
 delete the LinearConstraint obj.lcon{cnstr_idx} from the program More...
 
function updateLinearConstraint (obj, varargin)
 updateLinearConstraint(obj,cnstr_id,cnstr,xind) update the linear constraint whose id=cnstr_id with a new Constraint object cnstr, the newly added Constraint cnstr has the ID new_cnstr_id More...
 
function deleteBoundingBoxConstraint (obj, cnstr_id)
 delete the BoundingBoxConstraint in obj.bbcon with ID=cnstr_id from the program More...
 
function updateBoundingBoxConstraint (obj, varargin)
 updateBoundingBoxConstraint(obj,cnstr_id,cnstr,xind) update the BoundingBoxConstraint whose id=cnstr_id with a new BoundingBoxConstraint cnstr More...
 

Public Attributes

Property v_inds
 
- Public Attributes inherited from DirtranTrajectoryOptimization
Constant Property FORWARD_EULER
 
Constant Property BACKWARD_EULER
 
Constant Property MIDPOINT = 3
 DEFAULT. More...
 

Additional Inherited Members

- Protected Member Functions inherited from DirtranTrajectoryOptimization
function forward_constraint_fun (obj, h, x0, x1, u)
 
function backward_constraint_fun (obj, h, x0, x1, u)
 
function midpoint_constraint_fun (obj, h, x0, x1, u0, u1)
 
function midpoint_running_fun (obj, running_handle, h, x0, x1, u0, u1)
 
- Protected Member Functions inherited from DirectTrajectoryOptimization
function final_cost (obj, final_cost_function, h, x)
 
- Protected Member Functions inherited from NonlinearProgram
function snopt (obj, x0)
 
function fmincon (obj, x0)
 if (obj.num_cin + obj.num_ceq) nonlinearConstraints = .nonlinearConstraint; else nonlinearConstraints = []; end More...
 
function ipopt (obj, x0)
 
function setVarBounds (obj, lb, ub)
 
function mapSolverInfo (obj, exitflag, x)
 Based on the solver information and solution, re-map the info. More...
 
- Protected Attributes inherited from KinematicTrajectoryOptimization
Property nq
 
Property q_inds
 
Property kinsol_dataind
 
Property qsc_weight_inds
 
Property robot
 
- Protected Attributes inherited from DirectTrajectoryOptimization
Property N
 
Property options
 
Property plant
 
Property h_inds
 
Property x_inds
 
Property u_inds
 
Property dynamic_constraints
 
Property constraints
 
- Protected Attributes inherited from NonlinearProgram
Property num_vars
 
Property num_cin
 
Property num_ceq
 
Property Ain
 
Property bin
 
Property Ain_name
 
Property Aeq
 
Property beq
 
Property Aeq_name
 
Property cin_lb
 
Property cin_ub
 
Property cin_name
 
Property ceq_name
 
Property x_lb
 
Property x_ub
 
Property x_name
 
Property solver
 
Property solver_options
 
Property display_funs
 
Property display_fun_indices
 
Property check_grad
 
Property constraint_err_tol
 numerical gradient at the begining and end of the nonlinear optimization More...
 
Property nlcon
 
Property lcon
 
Property bbcon
 
Property cost
 
Property nlcon_xind
 
Property bbcon_xind
 nlcon{i}.eval(x(nlcon_xind{i}{1},x(nlcon_xind{i}{2},) cost_xind_cell % A cell array, cost_xind{i} is a cell array of int vectors recording the indices of x that is used in evaluating obj.cost{i} More...
 
Property shared_data_xind_cell
 a cell array like nlcon_xind, where shared_data_xind_cell{i} is a cell array of int vectors recording indices used in evaluating the shared_data_function More...
 
Property nlcon_dataind
 a cell array of function handles, each of which returns a data object so that shared_data{i} = shared_data_functions(x(shared_data_xind_cell{i}{1}),x(shared_data_xind_cell{i}{2}),) shared_data_functions More...
 
Property cost_dataind
 
Property iFfun
 2 if user has their own snopt in MATLAB path More...
 
Property iCinfun
 
Property iCeqfun
 

Detailed Description

Trajectory planning problem in which the acceleration of the joints is taken to be directly controllable.

The decision variables are the joint postitions (q), velocities (v), and accelerations (u) at each knot point. Linear interpolation is used to enforce the relationships between those quantities as described in DirtranTrajectoryOptimization.

Constructor & Destructor Documentation

function KinematicDirtran ( robot  ,
N  ,
duration  ,
options   
)

corresponding to the velocities at each knot point.

Return values
obj

Member Function Documentation

function addConstraint ( obj  ,
constraint  ,
varargin   
)
Return values
obj
function solveTraj ( obj  ,
t_init  ,
q_traj_init   
)
Return values
xtraj
z
F
info

Member Data Documentation

Property v_inds

The documentation for this class was generated from the following file: