magpie.data.utilities.generators

Class PrototypeEntryGenerator

java.lang.Object

magpie.data.utilities.generators.BaseEntryGenerator

magpie.data.utilities.generators.PrototypeEntryGenerator

All Implemented Interfaces:

java.lang.Iterable<BaseEntry>, Options

public class PrototypeEntryGenerator
extends BaseEntryGenerator

Generate PrototypeEntry with certain elements (or combination of elements on each site).

Usage: <site info> -site <order> <spacing> <elements...> [-site <...>]
site info: Path to file describing site information
order: Maximum number of elements mixing on A site (≥ 1)
spacing: Spacing (in at%) between mixed composition on each site. Example, 50 will generate A, AB, and B.
elements: List of elements, by abbreviation that could exist on each site.
Note: You must define the "-site" information for each site in the prototype in the order they are listed in the "site info" file.

See Also:

PrototypeDataset

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.Integer,java.lang.Double>>	AllowedMixing Allowed mixing on each site.
protected java.util.List<java.util.Set<java.lang.Integer>>	SiteElements Lists of possible elements on each site
protected PrototypeSiteInformation	SiteInfo Description of sites on prototype

Constructor Summary

Constructors

Constructor and Description
PrototypeEntryGenerator()

Method Summary

Modifier and Type	Method and Description
void	defineSitePossibilities(int index, int order, double spacing, java.util.Collection<java.lang.String> possibSiteElements) Define the possible compositions for each site.
static java.util.List<java.util.List<CompositionEntry>>	generateCombinations(java.util.List<java.util.Set<java.lang.Integer>> possibleElements, java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.Integer,java.lang.Double>> generationSettings) Generate all possible combinations of compositions generated using a list of settings.
boolean	isSet() Check whether this generator is ready to go.
java.util.Iterator<BaseEntry>	iterator()
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setSiteInfo(PrototypeSiteInformation info) Define the information about the sites in the prototype.

Methods inherited from class magpie.data.utilities.generators.BaseEntryGenerator

addEntriesToDataset, generateEntries, train

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

SiteInfo

protected PrototypeSiteInformation SiteInfo

Description of sites on prototype

SiteElements

protected final java.util.List<java.util.Set<java.lang.Integer>> SiteElements

Lists of possible elements on each site

AllowedMixing

protected final java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.Integer,java.lang.Double>> AllowedMixing

Allowed mixing on each site. Listed as maximum number of elements, and the desired spacing between prototypes.

Constructor Detail

PrototypeEntryGenerator

public PrototypeEntryGenerator()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

setSiteInfo

public void setSiteInfo(PrototypeSiteInformation info)

Define the information about the sites in the prototype. Resets the information about what elements can be placed on each site.

Parameters:

info - Definition for the prototype

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

defineSitePossibilities

public void defineSitePossibilities(int index,
                                    int order,
                                    double spacing,
                                    java.util.Collection<java.lang.String> possibSiteElements)
                             throws java.lang.Exception

Define the possible compositions for each site.

Parameters:

index - Index of site

order - Maximum number of elements on sites

spacing - Spacing between elements in at%

possibSiteElements - Abbreviations of possible elements for each site

Throws:

java.lang.Exception

isSet

public boolean isSet()

Check whether this generator is ready to go.

Returns:

Whether it is ready

iterator

public java.util.Iterator<BaseEntry> iterator()

generateCombinations

public static java.util.List<java.util.List<CompositionEntry>> generateCombinations(java.util.List<java.util.Set<java.lang.Integer>> possibleElements,
                                                                                    java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.Integer,java.lang.Double>> generationSettings)

Generate all possible combinations of compositions generated using a list of settings. The output will be a collection including all possible combinations of all possible compositions on each site.

Parameters:

possibleElements - Possible elements on each site

generationSettings - Order of mixing to have on each site, and desired spacing

Returns:

List of all possible combinations of sites