TPCCLIB
Loading...
Searching...
No Matches
NLOPT Struct Reference

#include <tpcnlopt.h>

Data Fields

unsigned int totalNr
double * xfull
double * xlower
double * xupper
double * xdelta
double * xtol
double(* _fun )(int, double *, void *)
void * fundata
unsigned int maxFunCalls
unsigned int funCalls
double funval
unsigned int usePList
double * plist

Detailed Description

General settings for NLOPT routines; individual routines may not use all of these, and can require additional parameters.

Definition at line 25 of file tpcnlopt.h.

Field Documentation

◆ _fun

double(* NLOPT::_fun) (int, double *, void *)

Pointer to objective function; parameters are optimized to minimize the return value of this function.

Definition at line 42 of file tpcnlopt.h.

Referenced by nlopt1D(), nloptDuplicate(), nloptIATGO(), nloptInit(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptPowellBrent(), nloptSimplex(), nloptSimplexARRS(), and nloptSimplexMS().

◆ funCalls

unsigned int NLOPT::funCalls

◆ fundata

void* NLOPT::fundata

Pointer to data which is passed on to the function; NULL if not needed.

Definition at line 44 of file tpcnlopt.h.

Referenced by nlopt1D(), nloptDuplicate(), nloptIATGO(), nloptInit(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptPowellBrent(), nloptSimplex(), and nloptSimplexARRS().

◆ funval

double NLOPT::funval

The return value of objective function with xfull[] and fundata.

Definition at line 50 of file tpcnlopt.h.

Referenced by nlopt1D(), nloptDuplicate(), nloptIATGO(), nloptInit(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptSimplex(), nloptSimplexARRS(), nloptSimplexMS(), and nloptWrite().

◆ maxFunCalls

unsigned int NLOPT::maxFunCalls

Maximum allowed number of function calls; set to zero for no limit.

Definition at line 46 of file tpcnlopt.h.

Referenced by nloptDuplicate(), nloptIATGO(), nloptInit(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptSimplexARRS(), and nloptWrite().

◆ plist

double* NLOPT::plist

List of all visited parameters and objective function values; stored in order x[], funval, x[], funval, ... with length funCalls*(totalNr+1); updated only if usePList!=0 (above).

Definition at line 56 of file tpcnlopt.h.

Referenced by nloptAddP(), nloptFree(), nloptIATGO(), nloptInit(), nloptMeanP(), nloptMPSO(), nloptPrintP(), nloptSimplexARRS(), and nloptSortP().

◆ totalNr

◆ usePList

unsigned int NLOPT::usePList

Keep (1) or do not keep (0) plist (below).

Definition at line 52 of file tpcnlopt.h.

Referenced by nlopt1D(), nloptAddP(), nloptDuplicate(), nloptIATGO(), nloptInit(), nloptMeanP(), nloptMPSO(), nloptPrintP(), nloptSimplex(), nloptSimplexARRS(), nloptSortP(), and nloptWrite().

◆ xdelta

double* NLOPT::xdelta

Array of (initial) steps for parameters, including fixed ones; set it to the expected distance from the solution.

Definition at line 36 of file tpcnlopt.h.

Referenced by nlopt1D(), nloptAllocate(), nloptDuplicate(), nloptFixedNr(), nloptFree(), nloptIATGO(), nloptInit(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptPowellBrent(), nloptRemoveEmpties(), nloptSimplex(), nloptSimplexARRS(), nloptSimplexMS(), and nloptWrite().

◆ xfull

double* NLOPT::xfull

◆ xlower

double* NLOPT::xlower

◆ xtol

double* NLOPT::xtol

Array of tolerances for parameters, including fixed ones; may be used as a stopping rule and for scaling.

Definition at line 39 of file tpcnlopt.h.

Referenced by nlopt1D(), nloptAllocate(), nloptDuplicate(), nloptFree(), nloptIATGO(), nloptInit(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptPowellBrent(), nloptRemoveEmpties(), nloptSimplex(), nloptSimplexARRS(), nloptSimplexMS(), and nloptWrite().

◆ xupper

double* NLOPT::xupper

The documentation for this struct was generated from the following file: