Class

org.pmml4s.model

SimpleRule

Related Doc: package model

Permalink

class SimpleRule extends Rule with HasScoreDistributions with PmmlElement

SimpleRule consists of an identifier, a predicate, a score and information on rule performance.

Linear Supertypes
PmmlElement, Serializable, Serializable, HasExtensions, HasScoreDistributions, Rule, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleRule
  2. PmmlElement
  3. Serializable
  4. Serializable
  5. HasExtensions
  6. HasScoreDistributions
  7. Rule
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SimpleRule(predicate: Predicate, scoreDistributions: ScoreDistributions, score: Any, id: Option[String] = None, recordCount: Option[Int] = None, nbCorrect: Option[Int] = None, confidence: Double = 1.0, weight: Double = 1.0)

    Permalink

    predicate

    the condition upon which the rule fires. For more details on PREDICATE see the section on predicates in TreeModel. This explains how predicates are described and evaluated and how missing values are handled.

    scoreDistributions

    Describes the distribution of the predicted value for instances where the rule fires in the training/test data.

    score

    The predicted value when the rule fires.

    id

    The value of id serves as a unique identifier for the rule. Must be unique within the ruleset.

    recordCount

    The number of training/test instances on which the rule fired.

    nbCorrect

    Indicates the number of training/test instances on which the rule fired and the prediction was correct.

    confidence

    Indicates the confidence of the rule.

    weight

    Indicates the relative importance of the rule. May or may not be equal to the confidence.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val confidence: Double

    Permalink

    Indicates the confidence of the rule.

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def extensions: Seq[Extension]

    Permalink
    Definition Classes
    HasExtensions
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fire(series: Series): Array[SimpleRule]

    Permalink
    Definition Classes
    SimpleRuleRule
  12. def first(series: Series): Option[SimpleRule]

    Permalink
    Definition Classes
    SimpleRuleRule
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def getConfidence(value: Any): Double

    Permalink
    Definition Classes
    HasScoreDistributions
  15. def getProbability(value: Any): Double

    Permalink
    Definition Classes
    HasScoreDistributions
  16. def getScoreDistribution(value: Any): Option[ScoreDistribution]

    Permalink
    Definition Classes
    HasScoreDistributions
  17. def hasExtensions: Boolean

    Permalink
    Definition Classes
    HasExtensions
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. val id: Option[String]

    Permalink

    The value of id serves as a unique identifier for the rule.

    The value of id serves as a unique identifier for the rule. Must be unique within the ruleset.

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. val nbCorrect: Option[Int]

    Permalink

    Indicates the number of training/test instances on which the rule fired and the prediction was correct.

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val predicate: Predicate

    Permalink

    the condition upon which the rule fires.

    the condition upon which the rule fires. For more details on PREDICATE see the section on predicates in TreeModel. This explains how predicates are described and evaluated and how missing values are handled.

    Definition Classes
    SimpleRuleRule
  26. def probabilities: Map[Any, Double]

    Permalink
    Definition Classes
    HasScoreDistributions
  27. val recordCount: Option[Int]

    Permalink

    The number of training/test instances on which the rule fired.

  28. val score: Any

    Permalink

    The predicted value when the rule fires.

  29. val scoreDistributions: ScoreDistributions

    Permalink

    Describes the distribution of the predicted value for instances where the rule fires in the training/test data.

    Describes the distribution of the predicted value for instances where the rule fires in the training/test data.

    Definition Classes
    SimpleRuleHasScoreDistributions
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. val weight: Double

    Permalink

    Indicates the relative importance of the rule.

    Indicates the relative importance of the rule. May or may not be equal to the confidence.

Inherited from PmmlElement

Inherited from Serializable

Inherited from Serializable

Inherited from HasExtensions

Inherited from HasScoreDistributions

Inherited from Rule

Inherited from AnyRef

Inherited from Any

Ungrouped