IpoptApplication defines an interface application class for IPOPT solvers. More...

Inheritance diagram for IpoptApplication:
[legend]

Public Member Functions

 IpoptApplication (NonlinearProgram nlp,struct new_opts)
 The default constructor function. More...
 
function obj = initialize ()
 This function initialize the specific NLP application based on the nonlinear programming problem (specified by nlp). More...
 
function [ sol , info ] = optimize (x0)
 This function runs the solver's optimization routine for the NLP. More...
 
- Public Member Functions inherited from SolverApplication
virtual function  initialize (nlp)
 An abstract method that initialize the solver to be ready to solve the given NLP problem. More...
 
 SolverApplication ()
 The default constructor function. More...
 

Public Attributes

struct Objective
 A structure contains the information of objective functions. More...
 
struct Constraint
 A sturcture contains the information of constraints. More...
 
NonlinearProgram Nlp
 The nonlinear programming object. More...
 
- Public Attributes inherited from SolverApplication
struct Options
 A structure for NLP solver options. More...
 
- Public Attributes inherited from handle
 addlistener
 Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
 
 notify
 Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...
 
 delete
 Handle object destructor method that is called when the object's lifecycle ends. More...
 
 disp
 Handle object disp method which is called by the display method. See the MATLAB disp function. More...
 
 display
 Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...
 
 findobj
 Finds objects matching the specified conditions from the input array of handle objects. More...
 
 findprop
 Returns a meta.property objects associated with the specified property name. More...
 
 fields
 Returns a cell array of string containing the names of public properties. More...
 
 fieldnames
 Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...
 
 isvalid
 Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...
 
 eq
 Relational functions example. See details for more information. More...
 
 transpose
 Transposes the elements of the handle object array. More...
 
 permute
 Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...
 
 reshape
 hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...
 
 sort
 ort the handle objects in any array in ascending or descending order. More...
 

Detailed Description

IpoptApplication defines an interface application class for IPOPT solvers.

Author
Ayonga Hereid
Date
2016-10-22

Copyright (c) 2016, AMBER Lab All right reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted only in compliance with the BSD 3-Clause license, see http://www.opensource.org/licenses/bsd-license.php

Constructor & Destructor Documentation

◆ IpoptApplication()

IpoptApplication.IpoptApplication ( NonlinearProgram  nlp,
struct  new_opts 
)
inline

The default constructor function.

Parameters
nlpthe NLP problem object to be solved
new_optsthe new solver options
Required fields of nlp:

References struct_overlay().

Member Function Documentation

◆ initialize()

function obj = IpoptApplication.initialize ( )

This function initialize the specific NLP application based on the nonlinear programming problem (specified by nlp).

The initialization including group different types of constraints, index objective functions and constraints arrays, etc.

See also
NonlinearProgram
Generated fields of obj:

◆ optimize()

function [ sol , info ] = IpoptApplication.optimize (   x0)
virtual

This function runs the solver's optimization routine for the NLP.

Be sure the run the initialization procedure before run this function.

Implements SolverApplication.

Member Data Documentation

◆ Constraint

IpoptApplication.Constraint

A sturcture contains the information of constraints.

◆ Nlp

IpoptApplication.Nlp

The nonlinear programming object.

◆ Objective

IpoptApplication.Objective

A structure contains the information of objective functions.


The documentation for this class was generated from the following files:
  • /home/ayonga/.dropboxes/business/Dropbox/research/dzopt/frost/matlab/solver/@IpoptApplication/IpoptApplication.m
  • /home/ayonga/.dropboxes/business/Dropbox/research/dzopt/frost/matlab/solver/@IpoptApplication/initialize.m
  • /home/ayonga/.dropboxes/business/Dropbox/research/dzopt/frost/matlab/solver/@IpoptApplication/optimize.m