magpie.attributes.generators.composition

Class StoichiometricAttributeGenerator

java.lang.Object

magpie.attributes.generators.BaseAttributeGenerator

magpie.attributes.generators.composition.StoichiometricAttributeGenerator

All Implemented Interfaces:

java.io.Serializable, Citable, Commandable, Options

public class StoichiometricAttributeGenerator
extends BaseAttributeGenerator
implements Citable

Generate attributes based on stoichiometry of material. Includes attributes that are only based on the fractions of elements, but not what those elements actually are.

Currently includes:

1. Number of components
2. L_p norms of the fraction vector.

Usage: <p norms...>
p norms: Which p norms to compute (e.g., 2).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.Integer>	PNorms List of p norms to compute

Constructor Summary

Constructors

Constructor and Description
StoichiometricAttributeGenerator()

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Dataset data) Generate new attributes for a dataset.
void	addPNorm(int norm) Add a p norm to be computed
void	addPNorms(java.util.Collection<java.lang.Integer> norms) Add several norms to be computed
void	clearPNorms() Clear out the list of p norms to be computed
java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>>	getCitations() Return a list of citations for this object and any underlying objects.
java.lang.String	printDescription(boolean htmlFormat) Print out description of attributes.
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.

Methods inherited from class magpie.attributes.generators.BaseAttributeGenerator

runCommand

Methods inherited from class java.lang.Object

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

Field Detail

PNorms

protected java.util.Set<java.lang.Integer> PNorms

List of p norms to compute

Constructor Detail

StoichiometricAttributeGenerator

public StoichiometricAttributeGenerator()

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.

Specified by:

setOptions in interface Options

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

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

Specified by:

printUsage in interface Options

Returns:

Usage for this function

clearPNorms

public void clearPNorms()

Clear out the list of p norms to be computed

addPNorm

public void addPNorm(int norm)
              throws java.lang.Exception

Add a p norm to be computed

Parameters:

norm - Desired norm

Throws:

java.lang.Exception

addPNorms

public void addPNorms(java.util.Collection<java.lang.Integer> norms)
               throws java.lang.Exception

Add several norms to be computed

Parameters:

norms - Collection of norms

Throws:

java.lang.Exception

addAttributes

public void addAttributes(Dataset data)
                   throws java.lang.Exception

Description copied from class: BaseAttributeGenerator

Generate new attributes for a dataset. This operation must both add the new attribute names to the dataset and new values to each entry.

Specified by:

addAttributes in class BaseAttributeGenerator

Parameters:

data - Dataset to be added to

Throws:

java.lang.Exception

See Also:

Dataset.addAttribute(java.lang.String, double[])

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from class: BaseAttributeGenerator

Print out description of attributes.

Implementation Notes

Format should look like

[Full Name of generator]: (Number of attributes) Text description of what these attributes are

For HTML format, omit the ":".

Specified by:

printDescription in class BaseAttributeGenerator

Parameters:

htmlFormat - Whether to print in HTML format

Returns:

Description of the attributes

getCitations

public java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>> getCitations()

Description copied from interface: Citable

Return a list of citations for this object and any underlying objects.

Specified by:

getCitations in interface Citable

Returns:

List of pairs: [Reason for Citation], [Citation]