API

merge(traj1::NamedTrajectory, traj2::NamedTrajectory)
merge(trajs::AbstractVector{<:NamedTrajectory})

Returns a new NamedTrajectory object by merging NamedTrajectory objects.

Merge names are used to specify which components to merge by index. If no merge names are provided, all components are merged and name collisions are not allowed. If merge names are provided, the names are merged using the data from the index provided in the merge names.

Keyword Arguments

• timestep::Symbol: The timestep symbol to use for free time problems. Default to the last trajectory.
• merge_names::Union{Nothing, NamedTuple{<:Any, <:Tuple{Vararg{Int}}}}=nothing: The names to merge by index.

add_component(traj, name::Symbol, data::AbstractVecOrMat)

Add a component to the trajectory.

Keyword arguments: - type::Symbol: The type of the component, can be :state, :control, :slack, or :global. Default is :state.

add_components(traj, comps)

Add components to the trajectory.

Keyword arguments: - type::Symbol: The type of the component, can be :state, :control, :slack, or :global. Default is :state.

add_suffix(obj::T, suffix::String)

Add the suffix to the symbols of the object.

get_component_names(traj::NamedTrajectory, comps::AbstractVector{<:Int})

Returns the name of the component with the given indices. If only one component is found, the name is returned as a single symbol. Else, the names are returned as a vector of symbols.

The filter requires that the components are a complete subset of the given indices, so that a partial match is excluded from the returned names.

get_components(names, ::NamedTrajectory)

Returns a NamedTuple containing the names and corresponding data matrices of the trajectory.

get_duration(::NamedTrajectory)

Returns the duration of a trajectory.

get_suffix(obj::T, suffix::String; remove::Bool=false)

Get the data with the suffix from the object. Remove the suffix if remove=true.

get_times(traj)::Vector{Float64}

Returns the times of a trajectory as a vector.

get_timesteps(::NamedTrajectory)

Returns the timesteps of a trajectory as a vector.

merge_outer(objs::AbstractVector{<:Any})

Merge objects. An error is reported if a key collision is detected.

remove_component(traj, name::Symbol)

Remove a component from the trajectory.

remove_components(traj, names::Vector{Symbol})

Remove a set of components from the trajectory.

remove_suffix(obj::T, suffix::String)

Remove the suffix from the symbols of the object.

update!(traj, datavec::AbstractVector{Float64})

Update the trajectory with a new datavec.

Keyword arguments: - type::Symbol: The type of the datavec, can be :data, :global, or :both. Default is global.

update!(traj, name::Symbol, data::AbstractMatrix{Float64})

Update a component of the trajectory.

update_bound!(traj, name, new_bound)

Update the bound of a component of the trajectory.

getproperty(slice::KnotPoint, symb::Symbol)

Returns the component of the knot point with name symb (as a view) or the property of the knot point with name symb.

setproperty!(slice::KnotPoint, symb::Symbol, val::Any)

Dispatches setting properties of knot points as either setting a component or a property via update! or setfield!, respectively.

update!(slice::KnotPoint, symb::Symbol, data::AbstractVector{Float64})

Update a component of the knot point.

rand(
    ::Type{NamedTrajectory},
    T::Int;
    timestep_value::Float64=1.0,
    timestep_name::Symbol=:Δt,
    timestep::Union{Float64,Symbol}=free_time ? timestep_name : timestep_value,
    state_dim::Int=3,
    control_dim::Int=2
)

Create a random NamedTrajectory with T time steps, a state variable x of dimension state_dim, and a control variable u of dimension control_dim. The time step is a symbol timestep_name and the time step value is timestep_value.

NamedTrajectory{R <: Real}

Container for trajectory optimization problems, which includes the trajectory data, bounds dimensions, initial and final conditions, goal states, and components.

This struct is designed to hold trajectory data in a named format, allowing for easy access to knot points by Symbol.

NamedTrajectory is designed to make allocation-free access easy to write. The data can be updated after construction, but the fields cannot.

NamedTrajectory(component_data, global_components_data)

Construct a NamedTrajectory from component data and global component data

NamedTrajectory(component_data)

Construct a NamedTrajectory from component data.

NamedTrajectory(component_data::NamedTuple, timestep; kwargs...)

Construct a NamedTrajectory from mixed Matrix/Vector component data.

NamedTrajectory(data, traj)

Construct a NamedTrajectory from an existing NamedTrajectory.

NamedTrajectory(data, components; kwargs...)

Construct a NamedTrajectory from a data matrix and components.

NamedTrajectory(datavec, components, T)

Construct a named trajectory from a data vector, components, and knot points.

get_bounds_from_dims(bounds, dims; dtype=Float64)

Process bounds from allowed types using dims and convert to dtype.

inspect_dims_pairs(dims_pairs, bounds, initial, final, goal)

Check for proper formatting of trajectory components.

inspect_names(names, controls, initial, final, goal, bounds)

Check for missing names in the trajectory components.

KnotPoint constructor

derivative(X::AbstractMatrix, Δt::AbstractVecOrMat)
derivative(X::AbstractMatrix, Δt::Float64)

Compute the derivative of the data matrix X.

integral(X::AbstractMatrix, Δt::AbstractVector)
integral(X::AbstractMatrix, Δt::Float64)

Compute the integral of the data matrix X.