umontreal.ssj.latnetbuilder.Search Class Reference

Abstract class for the search of highly uniform point sets with LatNet Builder. More...

Inheritance diagram for umontreal.ssj.latnetbuilder.Search:

Public Member Functions
String	toString ()
	Formats the search parameters for printing.
abstract String	pointSetType ()
	Returns the type of the searched point set.
abstract String	interlacing ()
	Returns the interlacing factor of the search.
abstract PointSet	search () throws RuntimeException
	Executes the search and returns the corresponding point set.
double	merit ()
	Returns the merit value of the point set.
double	time ()
	Returns the elapsed CPU time taken for the search.
boolean	successful ()
	Returns a boolean indicating if the search was successful.
void	setPathToLatNetBuilder (String path)
	Sets the path to the latnetbuilder executable.
void	setDimension (String dimension)
	Sets the dimension of the searched point set.
void	setSizeParameter (String sizeParameter)
	Sets the size parameter of the point set.
void	setMultilevel (boolean multilevel)
	Sets the search to the multilevel mode.
void	setCombiner (String combiner)
	Sets the combiner for the merit in the multilevel mode case.
void	setExplorationMethod (String explorationMethod)
	Sets the exploration method of the search.
void	setFigureOfMerit (String figure)
	Sets the figure of merit of the search.
void	setNormType (String normType)
	Sets the norm-type for the figure of merit of the search.
void	setWeights (List< String > weights)
	Sets the weights to the figure of merit of the search.
void	addWeight (String weight)
	Add a weight to the figure of merit of the search.
void	setFilters (List< String > filters)
	Sets the filters of the search.
void	setPathToOutputFolder (String path)
	Sets the path to the output folder.

Protected Member Functions
	Search ()
	Constructor.
ArrayList< String >	executeCommandLine ()
	Executes the command-line and reads the content of the outputMachine.txt file.

Detailed Description

Abstract class for the search of highly uniform point sets with LatNet Builder.

See the Summary of Command-Line Options of LatNet Builder for details about the various fields of this class.

Definition at line 47 of file Search.java.

Constructor & Destructor Documentation

Search()

umontreal.ssj.latnetbuilder.Search.Search ( )

protected

Constructor.

Definition at line 70 of file Search.java.

Member Function Documentation

addWeight()

void umontreal.ssj.latnetbuilder.Search.addWeight

(

String

weight

)

Add a weight to the figure of merit of the search.

Parameters

weight

Weight.

Definition at line 297 of file Search.java.

executeCommandLine()

ArrayList< String > umontreal.ssj.latnetbuilder.Search.executeCommandLine ( )

protected

Executes the command-line and reads the content of the outputMachine.txt file.

Definition at line 139 of file Search.java.

interlacing()

abstract String umontreal.ssj.latnetbuilder.Search.interlacing ( )

abstract

Returns the interlacing factor of the search.

Reimplemented in umontreal.ssj.latnetbuilder.DigitalNetSearch, and umontreal.ssj.latnetbuilder.OrdinaryLatticeSearch.

merit()

double umontreal.ssj.latnetbuilder.Search.merit

(

)

Returns the merit value of the point set.

Definition at line 188 of file Search.java.

pointSetType()

abstract String umontreal.ssj.latnetbuilder.Search.pointSetType ( )

abstract

Returns the type of the searched point set.

Reimplemented in umontreal.ssj.latnetbuilder.DigitalNetSearch, umontreal.ssj.latnetbuilder.OrdinaryLatticeSearch, and umontreal.ssj.latnetbuilder.PolynomialLatticeSearch.

search()

abstract PointSet umontreal.ssj.latnetbuilder.Search.search ( ) throws RuntimeException

abstract

Executes the search and returns the corresponding point set.

Reimplemented in umontreal.ssj.latnetbuilder.DigitalNetSearch, and umontreal.ssj.latnetbuilder.OrdinaryLatticeSearch.

setCombiner()

void umontreal.ssj.latnetbuilder.Search.setCombiner

(

String

combiner

)

Sets the combiner for the merit in the multilevel mode case.

Parameters

combiner

Combiner.

Definition at line 252 of file Search.java.

setDimension()

void umontreal.ssj.latnetbuilder.Search.setDimension

(

String

dimension

)

Sets the dimension of the searched point set.

Parameters

dimension

Dimension of the point set.

Definition at line 224 of file Search.java.

setExplorationMethod()

void umontreal.ssj.latnetbuilder.Search.setExplorationMethod

(

String

explorationMethod

)

Sets the exploration method of the search.

Parameters

explorationMethod

Exploration method.

Definition at line 261 of file Search.java.

setFigureOfMerit()

void umontreal.ssj.latnetbuilder.Search.setFigureOfMerit

(

String

figure

)

Sets the figure of merit of the search.

Parameters

figure

Figure of merit.

Definition at line 270 of file Search.java.

setFilters()

void umontreal.ssj.latnetbuilder.Search.setFilters

(

List< String >

filters

)

Sets the filters of the search.

Parameters

filters

List of filters.

Definition at line 306 of file Search.java.

setMultilevel()

void umontreal.ssj.latnetbuilder.Search.setMultilevel

(

boolean

multilevel

)

Sets the search to the multilevel mode.

Parameters

multilevel

Flag for the multilevel mode.

Definition at line 243 of file Search.java.

setNormType()

void umontreal.ssj.latnetbuilder.Search.setNormType

(

String

normType

)

Sets the norm-type for the figure of merit of the search.

Parameters

normType

Norm-type.

Definition at line 279 of file Search.java.

setPathToLatNetBuilder()

void umontreal.ssj.latnetbuilder.Search.setPathToLatNetBuilder

(

String

path

)

Sets the path to the latnetbuilder executable.

Parameters

path	Path to the latnetbuilder executable.

Definition at line 215 of file Search.java.

setPathToOutputFolder()

void umontreal.ssj.latnetbuilder.Search.setPathToOutputFolder

(

String

path

)

Sets the path to the output folder.

Definition at line 313 of file Search.java.

setSizeParameter()

void umontreal.ssj.latnetbuilder.Search.setSizeParameter

(

String

sizeParameter

)

Sets the size parameter of the point set.

Parameters

sizeParameter

Modulus for lattices and number of points for digital nets.

Definition at line 234 of file Search.java.

setWeights()

void umontreal.ssj.latnetbuilder.Search.setWeights

(

List< String >

weights

)

Sets the weights to the figure of merit of the search.

Parameters

weights

List of weights.

Definition at line 288 of file Search.java.

successful()

boolean umontreal.ssj.latnetbuilder.Search.successful

(

)

Returns a boolean indicating if the search was successful.

Definition at line 202 of file Search.java.

time()

double umontreal.ssj.latnetbuilder.Search.time

(

)

Returns the elapsed CPU time taken for the search.

Definition at line 195 of file Search.java.

toString()

String umontreal.ssj.latnetbuilder.Search.toString

(

)

Formats the search parameters for printing.

Definition at line 84 of file Search.java.

---

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

• src/main/java/umontreal/ssj/latnetbuilder/Search.java