R: R Optimization Infrastructure

# R Optimization Infrastructure

## Documentation for package ‘ROI’ version 1.0-1

- DESCRIPTION file.

## Help Pages

A B C D E F G I J K L M N O Q R S T U V

## -- A --

as.constraint | constraint
as.C_constraint | Conic Constraints
as.F_constraint | Function Constraints
as.F_constraint.constraint | Function Constraints
as.F_constraint.NO_constraint | Function Constraints
as.F_constraint.NULL | Function Constraints
as.F_objective | General (Nonlinear) Objective Function
as.L_constraint | Linear Constraints
as.L_objective | Linear Objective Function
as.L_term | Canonicalize the Linear Term
as.NO_constraint | Class: '"NO_constraint"'
as.objective | Objective - Accessor and Mutator Functions
as.OP | Optimization Problem Constructor
as.Q_constraint | Quadratic Constraints
as.Q_objective | Quadratic Objective Function
as.Q_term | Canonicalize the Quadraric Term
as.Q_term.list | Canonicalize the Quadraric Term
as.Q_term.matrix | Canonicalize the Quadraric Term
as.Q_term.NULL | Canonicalize the Quadraric Term
as.Q_term.numeric | Canonicalize the Quadraric Term
as.Q_term.simple_triplet_matrix | Canonicalize the Quadraric Term
as.V_bound | Objective Variable Bounds

## -- B --

bound (Constructors) | bound
bounds | Bounds - Accessor and Mutator Functions
bounds (Set/Get) | Bounds - Accessor and Mutator Functions
bounds.OP | Bounds - Accessor and Mutator Functions
bounds<- | Bounds - Accessor and Mutator Functions

## -- C --

c.bound | bound
c.constraint | constraint
constraint (Constructors) | constraint
constraint directions | Replicate '"=="', '">="' and '"<="' Signs
constraints | Constraints - Accessor and Mutator Functions
constraints (Set/Get) | Constraints - Accessor and Mutator Functions
constraints.OP | Constraints - Accessor and Mutator Functions
constraints<- | Constraints - Accessor and Mutator Functions
C_constraint | Conic Constraints

## -- D --

dim.constraint | constraint

## -- E --

eq | Replicate '"=="', '">="' and '"<="' Signs
equal | Compare two Objects
equal.character | Compare two Objects
equal.integer | Compare two Objects
equal.list | Compare two Objects
equal.logical | Compare two Objects
equal.L_constraint | Compare two Objects
equal.NULL | Compare two Objects
equal.numeric | Compare two Objects
equal.Q_constraint | Compare two Objects
equal.simple_triplet_matrix | Compare two Objects
equal.V_bound | Compare two Objects

## -- F --

F_constraint | Function Constraints
F_objective | General (Nonlinear) Objective Function

## -- G --

G | Extract Gradient information
geq | Replicate '"=="', '">="' and '"<="' Signs

## -- I --

is.bound | bound
is.constraint | constraint
is.C_constraint | Conic Constraints
is.default_bound | Check for default bounds
is.F_constraint | Function Constraints
is.L_constraint | Linear Constraints
is.NO_constraint | Class: '"NO_constraint"'
is.Q_constraint | Quadratic Constraints
is.V_bound | Objective Variable Bounds

## -- J --

J | Extract Jacobian Information
J.L_constraint | Extract Jacobian Information
J.Q_constraint | Extract Jacobian Information

## -- K --

K_expd | Cone Constructors
K_expp | Cone Constructors
K_lin | Cone Constructors
K_powd | Cone Constructors
K_powp | Cone Constructors
K_psd | Cone Constructors
K_soc | Cone Constructors
K_zero | Cone Constructors

## -- L --

length.C_constraint | Conic Constraints
length.L_constraint | Linear Constraints
length.Q_constraint | Quadratic Constraints
leq | Replicate '"=="', '">="' and '"<="' Signs
L_constraint | Linear Constraints
L_objective | Linear Objective Function

## -- M --

maximum | Maximum - Accessor and Mutator Functions
maximum (Set/Get) | Maximum - Accessor and Mutator Functions
maximum<- | Maximum - Accessor and Mutator Functions

## -- N --

nlminb2 | Nonlinear programming with nonlinear constraints.
NO_constraint | Class: '"NO_constraint"'

## -- O --

objective | Objective - Accessor and Mutator Functions
objective (Set/Get) | Objective - Accessor and Mutator Functions
objective<- | Objective - Accessor and Mutator Functions
OP | Optimization Problem Constructor
OP_signature | Optimization Problem Signature

## -- Q --

Q_constraint | Quadratic Constraints
Q_objective | Quadratic Objective Function

## -- R --

rbind.constraint | Combine Constraints
ROI_applicable_solvers | Obtain Applicable Solvers
ROI_available_solvers | Available Solvers
ROI_installed_solvers | Solver Tools
ROI_options | ROI Options
ROI_plugin_add_status_code_to_db | Add Status Code to the Status Database
ROI_plugin_build_equality_constraints | Build Functional Equality Constraints
ROI_plugin_build_inequality_constraints | Build Functional Inequality Constraints
ROI_plugin_canonicalize_solution | Canonicalize Solution
ROI_plugin_get_solver_name | Get Solver Name
ROI_plugin_make_signature | Make Signatures
ROI_plugin_register_reader | Register Reader / Writer Method
ROI_plugin_register_reader_writer | Register Reader / Writer Method
ROI_plugin_register_reformulation | Register Reformulation Method
ROI_plugin_register_solver_control | Register Solver Controls
ROI_plugin_register_solver_method | Register Solver Method
ROI_plugin_register_writer | Register Reader / Writer Method
ROI_plugin_solution_aux | Extract solution from the solver.
ROI_plugin_solution_dual | Extract solution from the solver.
ROI_plugin_solution_msg | Extract solution from the solver.
ROI_plugin_solution_objval | Extract solution from the solver.
ROI_plugin_solution_prim | Extract solution from the solver.
ROI_plugin_solution_prim.OP_solution | Extract solution from the solver.
ROI_plugin_solution_prim.OP_solution_set | Extract solution from the solver.
ROI_plugin_solution_psd | Extract solution from the solver.
ROI_plugin_solution_status | Extract solution from the solver.
ROI_plugin_solution_status_code | Extract solution from the solver.
ROI_read | Read Optimization Problems
ROI_reformulate | Reformulate a Optimization Problem
ROI_registered_reader | List Registered Reader
ROI_registered_reformulations | Registered Reformulations
ROI_registered_solvers | Solver Tools
ROI_registered_solver_control | Registered Solver Controls
ROI_registered_writer | Write Optimization Problems
ROI_require_solver | Require Solver
ROI_solve | Solve an Optimization Problem
ROI_solver_signature | Obtain Solver Signature
ROI_write | Write Optimization Problems

## -- S --

solution | Extract Solution

## -- T --

terms.C_constraint | Conic Constraints
terms.F_constraint | Function Constraints
terms.F_objective | General (Nonlinear) Objective Function
terms.L_constraint | Linear Constraints
terms.L_objective | Linear Objective Function
terms.Q_constraint | Quadratic Constraints
terms.Q_objective | Quadratic Objective Function
types | Types - Accessor and Mutator Functions
types (Set/Get) | Types - Accessor and Mutator Functions
types<- | Types - Accessor and Mutator Functions

## -- U --

US30 | Monthly return data for 30 of the largest US stocks

## -- V --

variable.names.C_constraint | Conic Constraints
variable.names.F_constraint | Function Constraints
variable.names.F_objective | General (Nonlinear) Objective Function
variable.names.L_constraint | Linear Constraints
variable.names.L_objective | Linear Objective Function
variable.names.Q_constraint | Quadratic Constraints
variable.names.Q_objective | Quadratic Objective Function
vech | Half-Vectorization
V_bound | Objective Variable Bounds