magpie.attributes.generators.composition

Class ElementPairPropertyAttributeGenerator

java.lang.Object

magpie.attributes.generators.BaseAttributeGenerator

magpie.attributes.generators.composition.ElementPairPropertyAttributeGenerator

All Implemented Interfaces:

java.io.Serializable, Commandable, Options

public class ElementPairPropertyAttributeGenerator
extends BaseAttributeGenerator

Attributes based on properties of constituent binary systems. Computes the minimum, maximum, and range of all pairs in the material, and the weighted mean and variance of all pairs. Pairs are weighted by the product of the fractions of each element. So, the weighted mean can be expressed as: $sum$_i,j[ x_i*x_j*f(i,j) ] / sum_i,j[ x_i*x_j ] where x_j is the fraction of element j, and f(i,j) is the property of the pair of i and j. Variance is defined as the mean absolute deviation from the mean over all pairs, and is weighted using a similar scheme.

If an entry only has one element. The value of NaN is used for all attributes

Usage: *No Options*

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ElementPairPropertyAttributeGenerator()

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Dataset data) Generate new attributes for a dataset.
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

Constructor Detail

ElementPairPropertyAttributeGenerator

public ElementPairPropertyAttributeGenerator()

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

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

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