Prototype

java.lang.Object
- keel.Algorithms.Semi_Supervised_Learning.Basic.Prototype

```
public class Prototype
extends java.lang.Object
```
Representation of a prototype. Contains several inputs an several outputs and common operations.

Author:

diegoj

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOUBLE` Double type of attributes.
`protected int`	`index` Index of the prototype in the set, used as an identifier.
`protected double[]`	`inputs` Normalized inputs of the prototype (values in [0,1]).
`static int`	`INTEGER` Integer type of attributes.
`static int`	`NOMINAL` Nominal type of attributes.
`protected double[]`	`outputs` Normalized outputs of the prototype (values in [0,1]).
`protected static int[]`	`type` Type of each attribute of the set.
`static int`	`UNKNOW_INDEX` Informs that the prototype has not got a definided index.
`static double`	`weight` weight of instance.

Constructor Summary

Constructors
Constructor and Description
`Prototype()` Default constructor.
`Prototype(double[] inputs, double[] outputs)` Constructs a Prototype.
`Prototype(Instance inst)` Constructs a Prototype from an instance.
`Prototype(int numInput, int numOutput)` Parameter constructor.
`Prototype(Prototype original)` Constructs a Prototype from another protoype.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Prototype`	`add(double increment)` Add an increment to all the inputs of the prototype
`Prototype`	`add(Prototype other)` Performs add operation between two prototypes.
`Prototype`	`addDiv(Prototype other, double divisor)` Performs add and divide operation between two prototypes.
`Prototype`	`addMul(Prototype other, double weight)` Performs add and product operation between two prototypes.
`void`	`applyThresholds()` Change attribute values that are not in [0.0, 1.0].
`double`	`assignedClass()` Returns the assigned class of the prototype (same value as the first output of the protoype).
`Prototype`	`avg(Prototype other)` Performs average operation between two prototypes.
`static Prototype`	`avg(Prototype p1, double w1, Prototype p2, double w2)` Performs averaged-based explicit operation between two prototypes.
`static Prototype`	`avg(Prototype p1, Prototype p2)` Performs average operation between two prototypes.
`Prototype`	`denormalize()` Denormalize the values of the inputs and outputs.
`boolean`	`equals(Prototype other)` Test if two prototypes are equals
`boolean`	`equalsInputs(Prototype other)` Test if two prototypes have the same inputs
`double`	`firstOutput()` Returns the first output of the protoype.
`Prototype`	`formatear()` This function is for NOminal adaptation...
`int`	`getIndex()` Informs of the index of the prototype.
`double`	`getInput(int i)` Returns a specific input of the protoype.
`java.lang.String`	`getInputAsNominal(int i)` Return an input as nominal.
`double[]`	`getInputs()` Returns the inputs of the protoype.
`double`	`getOutput(int i)` Returns a specific output of the protoype.
`java.lang.String`	`getOutputAsNominal(int i)` Return an output as nominal.
`double[]`	`getOutputs()` Returns the outputs of the protoype.
`Prototype`	`getPrototypeWithSelectedInputs(java.util.ArrayList<java.lang.Integer> lista)` Returns the prototype selected inputs of the prototype specified in lista.
`static int`	`getTypeOfAttribute(int i)` Return the type of the attribute.
`double`	`getWeight()` Informs of the weight of the prototype.
`double`	`label()` Returns the label of the prototype (aka first output).
`void`	`makeNull()` Convert the prototype in the null prototype
`double`	`module()`
`Prototype`	`mul(double weight)` Performs product operation between one prototype and a double.
`Prototype`	`mul(Prototype other)` Multiply component by component like a scalar product.
`double`	`mulEscalar(Prototype other)` Multiply component by component and sum them like a scalar product.
`protected static double`	`normalize(double min, double max, double value)` Normalizes a value given with its minimum and maximum values of its interval.
`int`	`numberOfInputs()` Returns the number of attributes that has an input.
`int`	`numberOfOutputs()` Returns the number of attributes that has an output.
`Prototype`	`opposite()` Opuesto de un prototipo
`static java.util.ArrayList<java.lang.Double>`	`possibleValuesOfOutput()` Return all the existing classes in our universe.
`void`	`print()` Print the prototype.
`protected static double`	`round(double value)` Rounds a value given.
`void`	`set(Prototype original)` Copy the values of a Prototype from another protoype.
`static void`	`setAttributesTypes()` Sets the attributes types.
`static void`	`setAttributesTypes(InstanceAttributes att)` Update the type of each attribute of the set.
`void`	`setClass(double val)` Assigns a new class (aka new first output) to the prototype.
`void`	`setFirstOutput(double val)` Assigns a new value to the first output of the prototype.
`void`	`setIndex(int index)` Assigns a new index to the prototype.
`void`	`setInput(int i, double valor)` Set a input for an attribute
`void`	`setLabel(double val)` Assigns a new label (aka first output, class) to the prototype.
`void`	`setWeight(double index)` Assigns a new weight to the prototype.
`Prototype`	`sqrt()` Performs sqrt operation to all the inputs of the prototype.
`Prototype`	`sub(Prototype other)` Performs substract operation between two prototypes.
`Prototype`	`subMul(Prototype other, double weight)` Performs substract and product operation between two prototypes.
`java.lang.String`	`toString()` Converts the prototype to a String object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNKNOW_INDEX
```
public static final int UNKNOW_INDEX
```
    Informs that the prototype has not got a definided index.
    
    See Also:
    
    Constant Field Values
  - index
```
protected int index
```
    Index of the prototype in the set, used as an identifier.
  - type
```
protected static int[] type
```
    Type of each attribute of the set.
  - weight
```
public static double weight
```
    weight of instance. By default is 1
  - INTEGER
```
public static final int INTEGER
```
    Integer type of attributes.
    
    See Also:
    
    Constant Field Values
  - DOUBLE
```
public static final int DOUBLE
```
    Double type of attributes.
    
    See Also:
    
    Constant Field Values
  - NOMINAL
```
public static final int NOMINAL
```
    Nominal type of attributes.
    
    See Also:
    
    Constant Field Values
  - inputs
```
protected double[] inputs
```
    Normalized inputs of the prototype (values in [0,1]).
  - outputs
```
protected double[] outputs
```
    Normalized outputs of the prototype (values in [0,1]).
- Constructor Detail
  - Prototype
```
public Prototype()
```
    Default constructor. Constructs a null prototype.
  - Prototype
```
public Prototype(int numInput,
                 int numOutput)
```
    Parameter constructor.
    
    Parameters:
    
    numInput - number of inputs.
    
    numOutput - number of outputs.
  - Prototype
```
public Prototype(double[] inputs,
                 double[] outputs)
```
    Constructs a Prototype.
    
    Parameters:
    
    inputs - Inputs that will contain the new prototype
    
    outputs - Ouputs that will contain the new prototype
  - Prototype
```
public Prototype(Instance inst)
```
    Constructs a Prototype from an instance.
    
    Parameters:
    
    inst - Instance that contains inputs and outputs that will be assigned to the new prototype.
  - Prototype
```
public Prototype(Prototype original)
```
    Constructs a Prototype from another protoype.
    
    Parameters:
    
    original - Prototype that will be copied into the new object.
- Method Detail
  - normalize
```
protected static double normalize(double min,
                                  double max,
                                  double value)
```
    Normalizes a value given with its minimum and maximum values of its interval.
    
    Parameters:
    
    min - minimum value.
    
    max - maximum value.
    
    value - given value to normalize.
    
    Returns:
    
    normalized value.
  - setAttributesTypes
```
public static void setAttributesTypes(InstanceAttributes att)
```
    Update the type of each attribute of the set.
    
    Parameters:
    
    att - InstanceAttributes object.
  - setAttributesTypes
```
public static void setAttributesTypes()
```
    Sets the attributes types.
  - getTypeOfAttribute
```
public static int getTypeOfAttribute(int i)
```
    Return the type of the attribute.
    
    Parameters:
    
    i - ith attribute.
    
    Returns:
    
    the type of the attribute asked.
  - getIndex
```
public int getIndex()
```
    Informs of the index of the prototype.
    
    Returns:
    
    Index of the prototype.
  - setWeight
```
public void setWeight(double index)
```
    Assigns a new weight to the prototype.
    
    Parameters:
    
    index - New index to be assigned.
  - getWeight
```
public double getWeight()
```
    Informs of the weight of the prototype.
    
    Returns:
    
    Index of the prototype.
  - setIndex
```
public void setIndex(int index)
```
    Assigns a new index to the prototype.
    
    Parameters:
    
    index - New index to be assigned.
  - set
```
public void set(Prototype original)
```
    Copy the values of a Prototype from another protoype.
    
    Parameters:
    
    original - Prototype that will be copied into the new object.
  - getInputs
```
public double[] getInputs()
```
    Returns the inputs of the protoype.
    
    Returns:
    
    Array with the inputs of the prototype.
  - getPrototypeWithSelectedInputs
```
public Prototype getPrototypeWithSelectedInputs(java.util.ArrayList<java.lang.Integer> lista)
```
    Returns the prototype selected inputs of the prototype specified in lista.
    
    Parameters:
    
    lista - prototype specified.
    
    Returns:
    
    Array with the selected inputs of the prototype.
  - getInput
```
public double getInput(int i)
```
    Returns a specific input of the protoype.
    
    Parameters:
    
    i - Index of the input attribute.
    
    Returns:
    
    Value of the input of that attribute.
  - setInput
```
public void setInput(int i,
                     double valor)
```
    Set a input for an attribute
    
    Parameters:
    
    i - Index of the input attribute.
    
    valor - Value to set.
  - getOutputs
```
public double[] getOutputs()
```
    Returns the outputs of the protoype.
    
    Returns:
    
    Array with the outputs of the prototype.
  - getOutput
```
public double getOutput(int i)
```
    Returns a specific output of the protoype. Not to be used. Use label() instead.
    
    Parameters:
    
    i - Index of the output attribute.
    
    Returns:
    
    Value of the output of that attribute.
  - firstOutput
```
public double firstOutput()
```
    Returns the first output of the protoype.
    
    Returns:
    
    Value of the output of the first attribute.
  - label
```
public double label()
```
    Returns the label of the prototype (aka first output).
    
    Returns:
    
    Label of the prototype (AKA assigned class or first output).
  - assignedClass
```
public double assignedClass()
```
    Returns the assigned class of the prototype (same value as the first output of the protoype).
    
    Returns:
    
    Value of the assigned class.
  - numberOfInputs
```
public int numberOfInputs()
```
    Returns the number of attributes that has an input.
    
    Returns:
    
    Number of inputs of an example (prototype).
  - setFirstOutput
```
public void setFirstOutput(double val)
```
    Assigns a new value to the first output of the prototype.
    
    Parameters:
    
    val - Value to be assigned to the first output (aka label) of the prototype.
  - setClass
```
public void setClass(double val)
```
    Assigns a new class (aka new first output) to the prototype.
    
    Parameters:
    
    val - Value to be assigned to the first output (aka label) of the prototype.
  - setLabel
```
public void setLabel(double val)
```
    Assigns a new label (aka first output, class) to the prototype.
    
    Parameters:
    
    val - Value to be assigned to the first output (aka class) of the prototype.*
  - numberOfOutputs
```
public int numberOfOutputs()
```
    Returns the number of attributes that has an output.
    
    Returns:
    
    Number of outputs of an example (prototype).
  - mul
```
public Prototype mul(Prototype other)
```
    Multiply component by component like a scalar product.
    
    Parameters:
    
    other - prototype to multiply with.
    
    Returns:
    
    A prototype which inputs product with other..
  - mulEscalar
```
public double mulEscalar(Prototype other)
```
    Multiply component by component and sum them like a scalar product.
    
    Parameters:
    
    other - prototype to multiply with.
    
    Returns:
    
    Sum of the different products.
  - mul
```
public Prototype mul(double weight)
```
    Performs product operation between one prototype and a double.
    
    Parameters:
    
    weight - Constant to be multiplied to each sum.
    
    Returns:
    
    A prototype which inputs product with a weight.
  - sqrt
```
public Prototype sqrt()
```
    Performs sqrt operation to all the inputs of the prototype.
    
    Returns:
    
    A prototype which inputs are the sqrt(original).
  - module
```
public double module()
```
    Returns:
    
    the module of a Prototype, like the sqrt(a1^2 + a2^2...)
  - add
```
public Prototype add(double increment)
```
    Add an increment to all the inputs of the prototype
    
    Parameters:
    
    increment -
    
    Returns:
  - add
```
public Prototype add(Prototype other)
```
    Performs add operation between two prototypes.
    
    Parameters:
    
    other - A protype to be added to the implicit parameter.
    
    Returns:
    
    A prototype which inputs are the sum of another two, and outputs are a copy of implicit-ones.
  - addMul
```
public Prototype addMul(Prototype other,
                        double weight)
```
    Performs add and product operation between two prototypes.
    
    Parameters:
    
    other - A protype to be added and multiplied to the implicit parameter.
    
    weight - Constant to be multiplied to each sum.
    
    Returns:
    
    A prototype which inputs are the sum, multiplied with a weight, of another two. Outputs are a copy of implicit-ones.
  - addDiv
```
public Prototype addDiv(Prototype other,
                        double divisor)
```
    Performs add and divide operation between two prototypes.
    
    Parameters:
    
    other - A protype to be added and divided to the implicit parameter.
    
    divisor - Constant that divides each sum.
    
    Returns:
    
    A prototype which inputs are the sum, divides with divisor, of another two. Outputs are a copy of implicit-ones.
  - avg
```
public Prototype avg(Prototype other)
```
    Performs average operation between two prototypes.
    
    Parameters:
    
    other - A protype to be merged to the implicit parameter.
    
    Returns:
    
    A prototype which inputs are the sum, divided between two of another two. Outputs are a copy of implicit-ones.
  - avg
```
public static Prototype avg(Prototype p1,
                            Prototype p2)
```
    Performs average operation between two prototypes.
    
    Parameters:
    
    p1 - One protype to be merged.
    
    p2 - Other protype to be merged.
    
    Returns:
    
    A prototype which inputs are the sum, divided between two of another two. Outputs are a copy of p1.
  - avg
```
public static Prototype avg(Prototype p1,
                            double w1,
                            Prototype p2,
                            double w2)
```
    Performs averaged-based explicit operation between two prototypes.
    
    Parameters:
    
    p1 - One protype to be merged.
    
    w1 - Weight of prototype p1.
    
    p2 - Other protype to be merged.
    
    w2 - Weight of prototype p2.
    
    Returns:
    
    A prototype which inputs are (w1*p1.p1_inputs + w2*p2_inputs)/(w1+w2). Outputs are a copy of p1.
  - sub
```
public Prototype sub(Prototype other)
```
    Performs substract operation between two prototypes.
    
    Parameters:
    
    other - A protype to be substract to the implicit parameter.
    
    Returns:
    
    A prototype which inputs are the difference of another two, and outputs are a copy of implicit-ones.
  - subMul
```
public Prototype subMul(Prototype other,
                        double weight)
```
    Performs substract and product operation between two prototypes.
    
    Parameters:
    
    other - A protype to be substract and multiplied to the implicit parameter.
    
    weight - Constant to be multiplied to each difference.
    
    Returns:
    
    A prototype which inputs are the difference (multiplied with a weight) of another two. Outputs are a copy of implicit-ones.
  - toString
```
public java.lang.String toString()
```
    Converts the prototype to a String object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representation of a prototype.
  - round
```
protected static double round(double value)
```
    Rounds a value given.
    
    Parameters:
    
    value - given value.
    
    Returns:
    
    rounded value.
  - denormalize
```
public Prototype denormalize()
```
    Denormalize the values of the inputs and outputs.
    
    Returns:
    
    A denormalized prototype of implicit.
  - getInputAsNominal
```
public java.lang.String getInputAsNominal(int i)
```
    Return an input as nominal. Input attribute i must be nominal, if not, it crash.
    
    Parameters:
    
    i - Index of the input.
    
    Returns:
    
    The value of the input in String representation.
  - getOutputAsNominal
```
public java.lang.String getOutputAsNominal(int i)
```
    Return an output as nominal. Output attribute i must be nominal, if not, it crash.
    
    Parameters:
    
    i - Index of the outut.
    
    Returns:
    
    The value of the output in String representation.
  - possibleValuesOfOutput
```
public static java.util.ArrayList<java.lang.Double> possibleValuesOfOutput()
```
    Return all the existing classes in our universe.
    
    Returns:
    
    All the values of the outputs (clasess) that exists in the dataset.
  - equals
```
public boolean equals(Prototype other)
```
    Test if two prototypes are equals
    
    Parameters:
    
    other - The other prototype to be compared with the caller.
    
    Returns:
    
    true if the two prototypes are equal, false in other case.
  - equalsInputs
```
public boolean equalsInputs(Prototype other)
```
    Test if two prototypes have the same inputs
    
    Parameters:
    
    other - The other prototype to be compared with the caller.
    
    Returns:
    
    true if the two prototypes have the same inputs, false in other case.
  - applyThresholds
```
public void applyThresholds()
```
    Change attribute values that are not in [0.0, 1.0]. If an attribute is greater than 1.0, assigns 1.0 to it. If an attribute is smaller than 0.0, assigns 0.0 to it.
  - makeNull
```
public void makeNull()
```
    Convert the prototype in the null prototype
  - print
```
public void print()
```
    Print the prototype.
  - opposite
```
public Prototype opposite()
```
    Opuesto de un prototipo
    
    Returns:
  - formatear
```
public Prototype formatear()
```
    This function is for NOminal adaptation...
    
    Returns:

Class Prototype

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOW_INDEX

index

type

weight

INTEGER

DOUBLE

NOMINAL

inputs

outputs

Constructor Detail

Prototype

Prototype

Prototype

Prototype

Prototype

Method Detail

normalize

setAttributesTypes

setAttributesTypes

getTypeOfAttribute

getIndex

setWeight

getWeight

setIndex

set

getInputs

getPrototypeWithSelectedInputs

getInput

setInput

getOutputs

getOutput

firstOutput

label

assignedClass

numberOfInputs

setFirstOutput

setClass

setLabel

numberOfOutputs

mul

mulEscalar

mul

sqrt

module

add

add

addMul

addDiv

avg

avg

avg

sub

subMul

toString

round

denormalize

getInputAsNominal

getOutputAsNominal

possibleValuesOfOutput

equals

equalsInputs

applyThresholds

makeNull

print

opposite

formatear