RCAIDE.Framework.Optimization.Common.Nexus

Nexus

class Nexus(*args, **kwarg)

Bases: Data

noun (plural same or nexuses) -a connection or series of connections linking two or more things -a connected group or series: a nexus of ideas. -the central and most important point or place

This is the class that makes optimization possible. We put all the data and functions together to make your future dreams come true.

evaluate(x=None)

This function runs the problem you setup in RCAIDE If the last time you ran this the inputs were the same, a cache is used.

Assumptions: None

Source: N/A

Inputs: x [vector]

Outputs: None

Properties Used: None

objective(x=None)

Retrieve the objective value for your function

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: scaled_objective [float]

Properties Used: None

inequality_constraint(x=None)

Retrieve the inequality constraint values for your function

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: scaled_constraints [vector]

Properties Used: None

equality_constraint(x=None)

Retrieve the equality constraint values for your function

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: scaled_constraints [vector]

Properties Used: None

all_constraints(x=None)

Returns both the inequality and equality constraint values for your function

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: scaled_constraints [vector]

Properties Used: None

unpack_inputs(x=None)

Put’s the values of the problem in the right place.

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: None

Properties Used: None

constraints_individual(x=None)

Put’s the values of the problem in the right place.

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: None

Properties Used: None

finite_difference(x, diff_interval=1e-08)

Finite difference gradients and jacobians of the problem.

Assumptions: N/A

Source: N/A

Inputs: x [vector] diff_interval [float]

Outputs: grad_obj [vector] jac_con [array]

Properties Used: None

translate(x=None)

Make a pretty table view of the problem with objective and constraints at the current inputs

Assumptions: N/A

Source: N/A

Inputs: x [vector]

Outputs: inpu [array] const_table [array]

Properties Used: None