optimizers

class matRad_Optimizer

Bases: handle

matRad_Optimizer. This is the superclass for all optimizer to be used within matRad

References

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

The type of the None singleton.

Property Summary

options: options struct

showPlot = true

wResult

resultInfo

Method Summary

optimize(w0, optiProb, dij, cst)

getStatus()

static isAvailable()

class matRad_OptimizerSimulannealbnd

Bases: matRad_Optimizer

matRad_OptimizerSimulannealbnd implements the interface for the Simulated Annealing optimizer of the MATLAB Global Optimization toolbox

References

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

matRad_OptimizerSimulannealbnd Constructor

Property Summary

options: the optimoptions for simulannealbnd

wResult: last optimization result

resultInfo: info struct about last results

Method Summary

optimize(w0, optiProb, dij, cst)

getStatus()

static isAvailable()

class matRad_OptimizerIPOPT(None)

Bases: matRad_Optimizer

matRad_OptimizerIPOPT implements the interface for ipopt

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

References

Construct an instance of the IPOPT optimizer (mex interface)

Property Summary

options

env

wResult

resultInfo

allObjectiveFunctionValues

axesHandle

plotHandle

abortRequested

plotFailed

Method Summary

optimize(w0, optiProb, dij, cst)

getStatus()

iterFunc(iter, objective, ~, ~)

plotFunction(): plot objective function output

abortCallbackKey(~, keyEvent): check if user pressed q

abortCallbackButton(~, ~, ~)

static isAvailable()

class matRad_OptimizerFmincon(None)

Bases: matRad_Optimizer

matRad_OptimizerFmincon implements the interface for the fmincon optimizer of the MATLAB Optiization toolbox

References

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

Construct an instance of the fmincon optimizer from the Optimization Toolbox

Property Summary

options: the optimoptions for fmincon

wResult: last optimization result

resultInfo: info struct about last results

Method Summary

optimize(w0, optiProb, dij, cst): optimize Carries Out the optimization

fminconObjAndGradWrapper(x, optiProb, dij, cst)

fminconNonlconWrapper(x, optiProb, dij, cst): Get the bounds of the constraint

getStatus()

static isAvailable(): ‘fmincon’ is a p-code file in the optimization toolbox