optimsimplex.getall: Optimsimplex Get Function Class

In sbihorel/optimsimplex: R Port of the 'Scilab' Optimsimplex Module

Description

The functions extract the content to various elements of a simplex object:

optimsimplex.getall

Get all the coordinates and the function values of all the vertices.

optimsimplex.getallfv

Get all the function values of all the vertices.

optimsimplex.getallx

Get all the coordinates of all the vertices.

optimsimplex.getfv

Get the function value at a given index.

optimsimplex.getn

Get the dimension of the space of the simplex.

optimsimplex.getnbve

Get the number of vertices of the simplex.

optimsimplex.getve

Get the vertex at a given index in the current simplex.

optimsimplex.getx

Get the coordinates of the vertex at a given index in the current simplex.

Usage

  optimsimplex.getall(this = NULL)
  optimsimplex.getallfv(this = NULL)
  optimsimplex.getallx(this = NULL)
  optimsimplex.getfv(this = NULL, ive = NULL)
  optimsimplex.getn(this = NULL)
  optimsimplex.getnbve(this = NULL)
  optimsimplex.getve(this = NULL, ive = NULL)
  optimsimplex.getx(this = NULL, ive = NULL)

Arguments

this	A simplex object.
ive	Vertex index.

Value

optimsimplex.getall

Return a nbve x n+1 matrix, where n is the dimension of the space, nbve is the number of vertices and with the following content:

• simplex[k,1] is the function value of the vertex k, with k = 1 to nbve,

• simplex[k,2:(n+1)] is the coordinates of the vertex k, with k = 1 to nbve.

optimsimplex.getallfv

Return a row vector of function values, which k^th element is the function value for the vertex k, with k = 1 to nbve.

optimsimplex.getallx

Return a nbve x n matrix of vertice coordinates; any given vertex is expected to be stored at row k, with k = 1 to nbve.

optimsimplex.getfv

Return a numeric scalar.

optimsimplex.getn

Return a numeric scalar.

optimsimplex.getnbve

Return a numeric scalar.

optimsimplex.getve

Return an object of class 'vertex', i.e. a list with the following elements:

n

The dimension of the space of the simplex.

x

The coordinates of the vertex at index ive.

fv

The value of the function at index ive.

optimsimplex.getx

Return a row vector, representing the coordinates of the vertex at index ive.

Author(s)

Author of Scilab optimsimplex module: Michael Baudin (INRIA - Digiteo)

Author of R adaptation: Sebastien Bihorel ([e-mail])

See Also

optimsimplex

sbihorel/optimsimplex documentation built on Jan. 31, 2022, 1:34 a.m.