CustomStartPointSet

Custom start points

Description

A CustomStartPointSet is an object wrapper of a matrix whose rows represent start points for MultiStart.

Creation

Syntax

tpoints = CustomStartPointSet(ptmatrix)

Description

tpoints = CustomStartPointSet(ptmatrix) generates a CustomStartPointSet object from the ptmatrix matrix. Each row of ptmatrix represents one start point.

Input Arguments

ptmatrix — Start points

matrix

Start points, specified as a matrix. Each row of ptmatrix represents one start point.

Example: randn(40,3) creates 40 start points of 3 dimensions.

Data Types: double

Properties

NumStartPoints — Number of start points

positive integer

This property is read-only.

Number of start points, specified as a positive integer. NumStartPoints is the number of rows in ptmatrix.

Example: 40

Data Types: double

StartPointsDimension — Dimension of each start point

positive integer

This property is read-only.

Dimension of each start point, specified as a positive integer. StartPointsDimension is the number of columns in ptmatrix.

StartPointsDimension is the same as the number of elements in problem.x0, the problem structure you pass to run.

Example: 5

Data Types: double

Object Functions

list	List start points

Examples

Create CustomStartPointSet

Create a CustomStartPointSet object with 64 three-dimensional points.

[x,y,z] = meshgrid(1:4);
ptmatrix = [x(:),y(:),z(:)] + [10,20,30];
tpoints = CustomStartPointSet(ptmatrix);

tpoints is the ptmatrix matrix contained in a CustomStartPointSet object.

Extract the original matrix from the tpoints object by using list.

tpts = list(tpoints);

Check that the tpts output is identical to ptmatrix.

isequal(ptmatrix,tpts)

ans = logical
   1

Version History

Introduced in R2010a