umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights Class Reference

Class implementing projection dependent weights. More...

Inheritance diagram for umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights:

Public Member Functions
void	setFileDir (String dir)
	Sets the directory to which an output-file can be generated.
String	getFileDir ()
	Returns the directory to which an output-file can be generated.
void	setFileName (String name)
	Sets the name of the file to which an output can be generated.
String	getFileName ()
	Returns the name of the file to which an output can be generated.
void	addOrderDependentWeight ()
	Instantiates the parameter orderDependentWeights.
void	addOrderDependentWeight (SingletonWeightComparable< Integer > weight)
	Adds an order dependent weight to orderDependentWeights.
void	addOrderDependentWeight (int order, double weight)
	Adds an order dependent weight to orderDependentWeights.
void	setOrderDependentWeights (ArrayList< SingletonWeightComparable< Integer > > ordWeights)
	Assigns an entire list of comparable 'SingleTonWeights' as order dependent weights to orderDependentWeights.
void	write () throws IOException
	Writes a file with name fileName to the directory fileDir containing information on the weights.
String	toString ()
	Creates a formatted output of the projection dependent weights.
Public Member Functions inherited from umontreal.ssj.latnetbuilder.weights.Weights< CoordinateSet >
	Weights (List< SingletonWeight< T > > w)
	Constructs weights from a list of SingletonWeights.
ArrayList< SingletonWeight< T > >	getWeights ()
	Returns the current weights as a list.
void	setDefaultWeight (double dWeight)
	Sets 'dWeight' as the current 'defaultWeight'.
double	getDefaultWeight ()
	Returns the current 'defaultWeight'.
void	add (SingletonWeight< T > singletonWeight)
	Adds a new weight.
String	toString ()
	Basic formatted string-output.
abstract String	toLatNetBuilder ()
	Provides a String that can be interpreted by the command line interface of LatNetBuilder.

Additional Inherited Members
Protected Attributes inherited from umontreal.ssj.latnetbuilder.weights.Weights< CoordinateSet >
double	defaultWeight
	Weight to be used for indices that were not explicitly set.

Detailed Description

Class implementing projection dependent weights.

In this case, weights are assigned to each projection individually. With a view to using this class together with LatticeBuilder it is also possible to set weights for the entire collections of projections of the same order via

OrderDependentWeights.

Author

florian

Definition at line 22 of file ProjectionDependentWeights.java.

Member Function Documentation

addOrderDependentWeight() [1/3]

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.addOrderDependentWeight

(

)

Instantiates the parameter orderDependentWeights.

Definition at line 67 of file ProjectionDependentWeights.java.

addOrderDependentWeight() [2/3]

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.addOrderDependentWeight	(	int	order,
		double	weight )

Adds an order dependent weight to orderDependentWeights.

Duplicate assignments to the same order are taken care of.

Parameters

order	the order of the projections for which the weight is assigned.
weight	the value of the weight that is to be added.

Definition at line 88 of file ProjectionDependentWeights.java.

addOrderDependentWeight() [3/3]

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.addOrderDependentWeight

(

SingletonWeightComparable< Integer >

weight

)

Adds an order dependent weight to orderDependentWeights.

Duplicate assignments to the same order are taken care of.

Parameters

weight

the comparable 'SingletonWeight' that is to be added.

Definition at line 77 of file ProjectionDependentWeights.java.

getFileDir()

String umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.getFileDir

(

)

Returns the directory to which an output-file can be generated.

Returns

path to an output directory.

Definition at line 42 of file ProjectionDependentWeights.java.

getFileName()

String umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.getFileName

(

)

Returns the name of the file to which an output can be generated.

Returns

name for output-file.

Definition at line 60 of file ProjectionDependentWeights.java.

setFileDir()

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.setFileDir

(

String

dir

)

Sets the directory to which an output-file can be generated.

Parameters

dir	path to an output directory.

Definition at line 33 of file ProjectionDependentWeights.java.

setFileName()

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.setFileName

(

String

name

)

Sets the name of the file to which an output can be generated.

Parameters

name	name for output-file.

Definition at line 51 of file ProjectionDependentWeights.java.

setOrderDependentWeights()

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.setOrderDependentWeights

(

ArrayList< SingletonWeightComparable< Integer > >

ordWeights

)

Assigns an entire list of comparable 'SingleTonWeights' as order dependent weights to orderDependentWeights.

Parameters

ordWeights

list of singleton weights representing the order dependent weights.

Definition at line 99 of file ProjectionDependentWeights.java.

toString()

String umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.toString

(

)

Creates a formatted output of the projection dependent weights.

Returns

a formatted output of the projection dependent weights.

Definition at line 130 of file ProjectionDependentWeights.java.

write()

void umontreal.ssj.latnetbuilder.weights.ProjectionDependentWeights.write

(

)

throws IOException

Writes a file with name fileName to the directory fileDir containing information on the weights.

This file is formatted to be further processed by *LatticeBuilder.**

Exceptions

IOException

Definition at line 110 of file ProjectionDependentWeights.java.

---

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

• src/main/java/umontreal/ssj/latnetbuilder/weights/ProjectionDependentWeights.java