Package org.tweetyproject.machinelearning

Class TrainingParameter

java.lang.Object
org.tweetyproject.machinelearning.TrainingParameter
public class TrainingParameter extends Object
A single parameter for a training method.
Author:
Matthias Thimm

  • Constructor Details

    • TrainingParameter

      public TrainingParameter​(String name, double defaultValue, double upperBound, double lowerBound)
      Creates a new training parameter with the given values and actual value as default value.
      Parameters:
      name - The identifier of the parameter.
      defaultValue - The default value of the parameter.
      upperBound - The upper bound of the parameter.
      lowerBound - The lower bound of the parameter.

    • TrainingParameter

      public TrainingParameter​(String name, double value, double defaultValue, double lowerBound, double upperBound)
      Creates a new training parameter with the given values.
      Parameters:
      name - The identifier of the parameter.
      value - The actual value of the parameter.
      defaultValue - The default value of the parameter.
      lowerBound - The lower bound of the parameter.
      upperBound - The upper bound of the parameter.

  • Method Details

    • instantiate

      public TrainingParameter instantiate​(double value)
      Instantiates a new parameter with the given value.
      Parameters:
      value - some value
      Returns:
      the training parameter obtained from instantiating.

    • instantiateWithDefaultValue

      public TrainingParameter instantiateWithDefaultValue()
      Instantiates a new parameter with the default value.
      Returns:
      the training parameter obtained from instantiating.

    • getName

      public String getName()
      Returns the name of this parameter.
      Returns:
      The name of this parameter.

    • getValue

      public double getValue()
      Returns the actual value of this parameter.
      Returns:
      The actual value of this parameter.

    • getDefaultValue

      public double getDefaultValue()
      Returns the default value of this parameter.
      Returns:
      The default value of this parameter.

    • getLowerBound

      public double getLowerBound()
      Returns the lower bound of this parameter.
      Returns:
      The lower bound of this parameter.

    • getUpperBound

      public double getUpperBound()
      Returns the upper bound of this parameter.
      Returns:
      The upper bound of this parameter.

    • toString

      public String toString()
      Overrides:
      toString in class Object