SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | Protected Member Functions | Package Attributes | Static Package Attributes | List of all members
Search Class Referenceabstract

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

Inheritance diagram for Search:
[legend]
Collaboration diagram for Search:
[legend]

Public Member Functions

String toString ()
 Formats the search parameters for printing.
 
abstract String pointSetType ()
 Returns the type of the searched point set.
 
abstract int interlacing ()
 Returns the interlacing factor of the search.
 
abstract String construction ()
 
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. More...
 
void setDimension (int dimension)
 Sets the dimension of the searched point set. More...
 
void setSizeParameter (String sizeParameter)
 Sets the size parameter of the point set. More...
 
void setMultilevel (boolean multilevel)
 Sets the search to the multilevel mode. More...
 
void setCombiner (String combiner)
 Sets the combiner for the merit in the multilevel mode case. More...
 
void setExplorationMethod (String explorationMethod)
 Sets the exploration method of the search. More...
 
void setFigureOfMerit (String figure)
 Sets the figure of merit of the search. More...
 
void setNormType (String normType)
 Sets the norm-type for the figure of merit of the search. More...
 
void setWeights (List< String > weights)
 Sets the weights to the figure of merit of the search. More...
 
void addWeight (String weight)
 Add a weight to the figure of merit of the search. More...
 
void setFilters (List< String > filters)
 Sets the filters of the search. More...
 
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.
 

Package Attributes

String pathToOutputFolder
 
String sizeParameter
 
int dimension
 
boolean multilevel
 
String combiner
 
String explorationMethod
 
String figure
 
String normType
 
ArrayList< String > weights
 
ArrayList< String > filters
 
boolean successful
 
double merit
 
double time
 

Static Package Attributes

static String PATH_TO_LATNETBUILDER = "latnetbuilder"
 

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.

Member Function Documentation

◆ addWeight()

void addWeight ( String  weight)

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

Parameters
weightWeight.

◆ setCombiner()

void setCombiner ( String  combiner)

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

Parameters
combinerCombiner.

◆ setDimension()

void setDimension ( int  dimension)

Sets the dimension of the searched point set.

Parameters
dimensionDimension of the point set.

◆ setExplorationMethod()

void setExplorationMethod ( String  explorationMethod)

Sets the exploration method of the search.

Parameters
explorationMethodExploration method.

◆ setFigureOfMerit()

void setFigureOfMerit ( String  figure)

Sets the figure of merit of the search.

Parameters
figureFigure of merit.

◆ setFilters()

void setFilters ( List< String >  filters)

Sets the filters of the search.

Parameters
filtersList of filters.

◆ setMultilevel()

void setMultilevel ( boolean  multilevel)

Sets the search to the multilevel mode.

Parameters
multilevelFlag for the multilevel mode.

◆ setNormType()

void setNormType ( String  normType)

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

Parameters
normTypeNorm-type.

◆ setPathToLatNetBuilder()

void setPathToLatNetBuilder ( String  path)

Sets the path to the latnetbuilder executable.

Parameters
pathPath to the latnetbuilder executable.

◆ setSizeParameter()

void setSizeParameter ( String  sizeParameter)

Sets the size parameter of the point set.

Parameters
sizeParameterModulus for lattices and number of points for digital nets.

◆ setWeights()

void setWeights ( List< String >  weights)

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

Parameters
weightsList of weights.

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