Package

org.pmml4s

common

Permalink

package common

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. common
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class AboveInterval(leftMargin: Double, isOpen: Boolean) extends Interval with Product with Serializable

    Permalink
  2. class AnyDistribution extends ContinuousDistribution

    Permalink
  3. class Application extends PmmlElement

    Permalink

    Describes the software application that generated the model.

  4. case class BelowInterval(rightMargin: Double, isOpen: Boolean) extends Interval with Product with Serializable

    Permalink
  5. class BooleanType extends DataType

    Permalink

    The data type representing Boolean values.

  6. class CategoricalPredictor extends RegressionPredictor

    Permalink

    Defines a categorical independent variable.

    Defines a categorical independent variable. The list of attributes comprises the name of the variable, the value attribute, and the coefficient by which the values of this variable must be multiplied.

  7. trait Clearable extends AnyRef

    Permalink
  8. trait ClsOutputs extends ModelOutputs with MutablePredictedValueWithProbabilities with MutablePredictedDisplayValue

    Permalink
  9. trait CluOutputs extends ModelOutputs with MutablePredictedValue with MutablePredictedDisplayValue with MutableEntityId with MutableAffinities

    Permalink
  10. class ComparisonMeasure extends PmmlElement

    Permalink
  11. class CompoundPredicate extends Predicate

    Permalink

    CompoundPredicate: an encapsulating element for combining two or more elements as defined at the entity PREDICATE.

    CompoundPredicate: an encapsulating element for combining two or more elements as defined at the entity PREDICATE. The attribute associated with this element, booleanOperator, can take one of the following logical (boolean) operators: and, or, xor or surrogate.

  12. trait ContinuousDistribution extends PmmlElement

    Permalink
  13. class ContrastMatrixFactorPredictor extends FactorPredictor

    Permalink
  14. class Counts extends PmmlElement

    Permalink

    Carries counters for frequency of values with respect to their state of being missing, invalid, or valid.

    Carries counters for frequency of values with respect to their state of being missing, invalid, or valid. The counts can be non-integer if they are weighted.

  15. class CovariatePredictor extends RegressionPredictor

    Permalink
  16. sealed abstract class DataType extends DataTypeLike

    Permalink

    The base type of all PMML data types.

  17. trait DataTypeLike extends Serializable

    Permalink

    A template trait for a data type.

  18. case class DateDaySinceYearType(aYear: Int) extends DateType with Product with Serializable

    Permalink

    The type dateDaysSince[aYear] is a variant of the type date where the values are represented as the number of days since aYear-01-01.

    The type dateDaysSince[aYear] is a variant of the type date where the values are represented as the number of days since aYear-01-01. The date aYear-01-01 is represented by the number 0. aYear-01-02 is represented by 1, aYear-02-01 is represented by 31, etc. Dates before aYear-01-01 are represented as negative numbers. For example, values of type dateDaysSince[1960] are the number of days since 1960-01-01. The date 1960-01-01 is represented by the number 0.

  19. case class DateTimeSecondSinceYearType(aYear: Int) extends DateTimeType with Product with Serializable

    Permalink

    The type dateTimeSecondsSince[aYear] is a variant of the type date where the values are represented as the number of seconds since 00:00 on aYear-01-01.

    The type dateTimeSecondsSince[aYear] is a variant of the type date where the values are represented as the number of seconds since 00:00 on aYear-01-01. The datetime 00:00:00 on aYear-01-01 is represented by the number 0. The datetime 00:00:01 on aYear-01-01 is represented by 1, etc. Datetimes before aYear-01-01 are represented as negative numbers. For example, values of type dateTimeSecondsSince[1960] are the number of seconds since 00:00 on 1960-01-01. The datetime 00:00:00 on 1960-01-01 is represented by the number 0. The datetime 00:01:00 on 1960-01-01 is represented by 60.

  20. sealed abstract class DateTimeType extends NumericType

    Permalink

    The base type of timestamp

  21. sealed abstract class DateType extends NumericType

    Permalink

    The base type of date

  22. class DenseMatrix extends Matrix

    Permalink

    Dense matrix

  23. class DenseVector[V] extends Vector[V]

    Permalink
  24. class DiagonalMatrix extends Matrix

    Permalink

    The content is just one array of numbers representing the diagonal values.

  25. trait Distance extends PmmlElement

    Permalink
  26. trait DoubleEvaluator extends PmmlElement

    Permalink
  27. class DoubleType extends NumericType

    Permalink

    The data type representing Double values.

  28. trait Evaluator extends PmmlElement

    Permalink

    A common super-trait that accepts a series, then evaluates a single value.

  29. case class Extension(extender: Option[String], name: Option[String], value: Option[Any], content: Option[Any]) extends Serializable with Product

    Permalink
  30. class FactorPredictor extends CategoricalPredictor

    Permalink
  31. class FloatType extends NumericType

    Permalink

    The data type representing Float values.

  32. class GaussianDistribution extends ContinuousDistribution

    Permalink
  33. case class GenericInterval(leftMargin: Double, rightMargin: Double, closure: Closure) extends Interval with Product with Serializable

    Permalink
  34. class GenericMultiModelOutputs extends MultiModelOutputs

    Permalink
  35. trait HasAffinities extends AnyRef

    Permalink
  36. trait HasAssociationRules extends AnyRef

    Permalink
  37. trait HasConfidence extends AnyRef

    Permalink
  38. trait HasDataType extends DataTypeLike

    Permalink
  39. trait HasDecision extends AnyRef

    Permalink
  40. trait HasEntityId extends AnyRef

    Permalink
  41. trait HasEntityIds extends AnyRef

    Permalink
  42. trait HasExtensions extends AnyRef

    Permalink

    The PMML schema contains a mechanism for extending the content of a model.

    The PMML schema contains a mechanism for extending the content of a model. Extension elements should be present as the first child in all elements and groups defined in PMML. This way it is possible to place information in the Extension elements which affects how the remaining entries are treated. The main element in each model should have Extension elements as the first and the last child for maximum flexibility.

  43. trait HasIntervals extends AnyRef

    Permalink
  44. trait HasModelAttributes extends AnyRef

    Permalink

    Holds common attributes of a PMML model.

  45. trait HasModelExplanation extends AnyRef

    Permalink
  46. trait HasModelStats extends AnyRef

    Permalink
  47. trait HasModelVerification extends AnyRef

    Permalink
  48. trait HasOpType extends AnyRef

    Permalink
  49. trait HasParent extends AnyRef

    Permalink
  50. trait HasPredictedDisplayValue extends AnyRef

    Permalink
  51. trait HasPredictedValue extends AnyRef

    Permalink
  52. trait HasPredictedValueWithProbabilities extends HasPredictedValue with HasProbabilities

    Permalink
  53. trait HasProbabilities extends AnyRef

    Permalink
  54. trait HasReasonCode extends AnyRef

    Permalink
  55. trait HasReasonCodes extends AnyRef

    Permalink
  56. trait HasResidual extends AnyRef

    Permalink
  57. trait HasScoreDistributions extends AnyRef

    Permalink
  58. trait HasSegment extends HasTransformedValue

    Permalink
  59. trait HasStandardError extends AnyRef

    Permalink
  60. trait HasTransformedValue extends AnyRef

    Permalink
  61. trait HasVersion extends AnyRef

    Permalink
  62. trait HasWarning extends AnyRef

    Permalink
  63. trait HasWrappedModelAttributes extends HasModelAttributes

    Permalink
  64. class Header extends PmmlElement

    Permalink

  65. class InlineTable extends Table

    Permalink
  66. class IntegerType extends NumericType

    Permalink

    The data type representing Int or Long values.

  67. sealed abstract class Interval extends PmmlElement

    Permalink

    Defines a range of numeric values.

  68. trait KNNOutputs extends ModelOutputs with MutablePredictedValue with MutablePredictedDisplayValue with MutableEntityIds with MutableAffinities

    Permalink
  69. case class MatCell(row: Int, col: Int, value: Double) extends Product with Serializable

    Permalink
  70. trait Matrix extends PmmlElement

    Permalink

    Trait for a matrix.

  71. trait MixedClsWithRegOutputs extends ClsOutputs with RegOutputs

    Permalink
  72. trait MixedEvaluator extends Evaluator with DoubleEvaluator

    Permalink
  73. class ModelAttributes extends HasModelAttributes with Serializable

    Permalink

    Class represents common attributes of a PMML model.

  74. class ModelExplanation extends PmmlElement

    Permalink

    Model Explanation

  75. trait ModelOutputs extends AnyRef

    Permalink
  76. class ModelStats extends PmmlElement

    Permalink

    Provides a basic framework for representing variable statistics.

  77. class ModelVerification extends PmmlElement

    Permalink

    Provides a dataset of model inputs and known results that can be used to verify accurate results are generated, regardless of the environment.

  78. trait MultiModelOutputs extends ModelOutputs

    Permalink
  79. trait MutableAffinities extends HasAffinities

    Permalink
  80. trait MutableConfidence extends HasConfidence

    Permalink
  81. trait MutableEntityId extends HasEntityId

    Permalink
  82. trait MutableEntityIds extends HasEntityIds

    Permalink
  83. trait MutablePredictedDisplayValue extends HasPredictedDisplayValue

    Permalink
  84. trait MutablePredictedValue extends HasPredictedValue

    Permalink
  85. trait MutablePredictedValueWithProbabilities extends HasPredictedValueWithProbabilities with MutablePredictedValue with MutableProbabilities

    Permalink
  86. trait MutableProbabilities extends HasProbabilities

    Permalink
  87. trait MutableReasonCodes extends HasReasonCodes

    Permalink
  88. trait MutableSegment extends HasSegment

    Permalink
  89. class NumericInfo extends PmmlElement

    Permalink

    The values for mean, minimum, maximum and standardDeviation are defined as usual.

    The values for mean, minimum, maximum and standardDeviation are defined as usual. median is calculated as the 50% quantile; interQuartileRange is calculated as (75% quantile - 25% quantile).

  90. class NumericPredictor extends RegressionPredictor

    Permalink

    Defines a numeric independent variable.

    Defines a numeric independent variable. The list of valid attributes comprises the name of the variable, the exponent to be used, and the coefficient by which the values of this variable must be multiplied. Note that the exponent defaults to 1, hence it is not always necessary to specify. Also, if the input value is missing, the result evaluates to a missing value.

  91. sealed abstract class NumericType extends DataType

    Permalink

    Numeric data types.

  92. sealed trait OpType extends AnyRef

    Permalink

    Indicates which operations are defined on the values.

  93. class Partition extends PmmlElement

    Permalink

    A Partition contains statistics for a subset of records, for example it can describe the population in a cluster.

    A Partition contains statistics for a subset of records, for example it can describe the population in a cluster. The content of a Partition mirrors the definition of the general univariate statistics. That is, each Partition describes the distribution per field. For each field there can be information about frequencies, numeric moments, etc.

    The attribute name identifies the Partition. The attribute size is the number of records. All aggregates in PartitionFieldStats must have size = totalFrequency in Counts if specified.

  94. class PartitionFieldStats extends PmmlElement

    Permalink

    field references to (the name of) a MiningField for background statistics.

    field references to (the name of) a MiningField for background statistics. The sequence of NUM-ARRAYs is the same as for ContStats. For categorical fields there is only one array containing the frequencies; for numeric fields, the second and third array contain the sums of values and the sums of squared values, respectively. The number of values in each array must match the number of categories or intervals in UnivariateStats of the field.

  95. trait PmmlElement extends HasExtensions with Serializable

    Permalink

    The base trait for all elements of PMML

  96. case class PointInterval(x: Double) extends Interval with Product with Serializable

    Permalink
  97. class PoissonDistribution extends ContinuousDistribution

    Permalink
  98. trait Predicate extends PmmlElement

    Permalink
  99. trait Predictable extends AnyRef

    Permalink
  100. class PredictorTerm extends RegressionPredictor

    Permalink

    Contains one or more fields that are combined by multiplication.

    Contains one or more fields that are combined by multiplication. That is, this element supports interaction terms. The type of all fields referenced within PredictorTerm must be continuous. Note that if the input value is missing, the result evaluates to a missing value.

  101. class Quantile extends PmmlElement

    Permalink

  102. class RealType extends NumericType

    Permalink

    The data type representing Float or Double values, the Real is an extended type beyond PMML

  103. trait RegOutputs extends ModelOutputs with MutablePredictedValue

    Permalink
  104. trait RegressionEvaluator extends Evaluator with DoubleEvaluator

    Permalink
  105. class RegressionParameter extends RegressionPredictor

    Permalink
  106. sealed trait RegressionPredictor extends RegressionEvaluator

    Permalink
  107. class RegressionTable extends RegressionPredictor

    Permalink

    Lists the values of all predictors or independent variables.

    Lists the values of all predictors or independent variables. If the model is used to predict a numerical field, then there is only one RegressionTable and the attribute targetCategory may be missing. If the model is used to predict a categorical field, then there are two or more RegressionTables and each one must have the attribute targetCategory defined with a unique value.

  108. class Row extends PmmlElement

    Permalink
  109. class ScoreDistribution extends PmmlElement

    Permalink

    Comprises a method to list predicted values in a classification trees structure.

  110. class ScoreDistributions extends PmmlElement

    Permalink
  111. trait SegmentOutputs extends ModelOutputs with MutableSegment

    Permalink
  112. class SimplePredicate extends Predicate

    Permalink

    Defines a rule in the form of a simple boolean expression.

    Defines a rule in the form of a simple boolean expression. The rule consists of field, operator (booleanOperator) for binary comparison, and value.

  113. class SimpleSetPredicate extends Predicate

    Permalink

    Checks whether a field value is element of a set.

    Checks whether a field value is element of a set. The set of values is specified by the array.

  114. class SparseMatrix extends Matrix

    Permalink

    Column-major sparse matrix.

  115. class SparseVector[V] extends Vector[V]

    Permalink
  116. class StringType extends DataType

    Permalink

    The data type representing String values.

  117. case class StructField(name: String, dataType: DataType) extends Product with Serializable

    Permalink

    A field inside a StructType.

    A field inside a StructType.

    name

    The name of this field.

    dataType

    The data type of this field.

  118. case class StructType(fields: Array[StructField]) extends DataType with Seq[StructField] with Product with Serializable

    Permalink

    StructType defines a type for a [Series]

  119. class SymmetricMatrix extends Matrix

    Permalink

    The content must be represented by Arrays.

    The content must be represented by Arrays. The first array contains the matrix element M(0,0), the second array contains M(1,0), M(1,1), and so on (that is the lower left triangle). Other elements are defined by symmetry.

  120. sealed trait Table extends PmmlElement

    Permalink
  121. class TableLocator extends Table

    Permalink
  122. class TimeSecondsType extends TimeType

    Permalink

    The type timeSeconds is a variant of the type time where the values are represented as the number of seconds since 00:00, that is, since midnight.

    The type timeSeconds is a variant of the type time where the values are represented as the number of seconds since 00:00, that is, since midnight. The time 00:00 is represented by the number 0. No negative values are allowed.

  123. class TimeType extends NumericType

    Permalink

    The data type representing Time values.

  124. trait Transformer extends AnyRef

    Permalink

    Abstract class for transformers that transform one series into another.

  125. class UniformDistribution extends ContinuousDistribution

    Permalink
  126. class Value extends PmmlElement

    Permalink
  127. trait Vector[V] extends Serializable

    Permalink
  128. class binarySimilarity extends Distance

    Permalink
  129. class minkowski extends Distance

    Permalink

Value Members

  1. object ArrayType extends Enumeration

    Permalink
  2. object BooleanType extends BooleanType with Product with Serializable

    Permalink
  3. object Closure extends Enumeration

    Permalink
  4. object CompareFunction extends Enumeration

    Permalink

    • absDiff: absolute difference c(x,y) = |x-y|
    • gaussSim: gaussian similarity c(x,y) = exp(-ln(2)*z*z/(s*s)) where z=x-y, and s is the value of attribute similarityScale (required in this case) in the ClusteringField
    • delta: c(x,y) = 0 if x=y, 1 else
    • equal: c(x,y) = 1 if x=y, 0 else
    • table: c(x,y) = lookup in similarity matrix
  5. object ComparisonMeasureKind extends Enumeration

    Permalink
  6. object CompoundPredicate extends Serializable

    Permalink
  7. object ContinuousDistribution extends Serializable

    Permalink
  8. object ContinuousDistributionType extends Enumeration

    Permalink
  9. object DataType extends Serializable

    Permalink
  10. object DateDaySinceYearType extends Product with Serializable

    Permalink
  11. object DateTimeSecondSinceYearType extends Product with Serializable

    Permalink
  12. object DateTimeType extends DateTimeType with Product with Serializable

    Permalink
  13. object DateType extends DateType with Product with Serializable

    Permalink
  14. object Distance extends Serializable

    Permalink
  15. object DoubleType extends DoubleType with Product with Serializable

    Permalink
  16. object False extends Predicate

    Permalink

    Identifies the boolean constant FALSE.

  17. object FloatType extends FloatType with Product with Serializable

    Permalink
  18. object InfinityInterval extends Interval with Product with Serializable

    Permalink
  19. object IntegerType extends IntegerType with Product with Serializable

    Permalink
  20. object Interval extends Serializable

    Permalink
  21. object MatrixKind extends Enumeration

    Permalink
  22. object MiningFunction extends Enumeration

    Permalink
  23. object OpType

    Permalink
  24. object Operator extends Enumeration

    Permalink

    Pre-defined comparison operators.

  25. object Predicate extends Serializable

    Permalink
  26. object Predication extends Enumeration

    Permalink
  27. object Property extends Enumeration

    Permalink

    • Valid value: A value which is neither missing nor invalid.
    • Invalid value: The input value is not missing but it does not belong to a certain value range. The range of valid values can be defined for each field.
    • Missing value: Input value is missing, for example, if a database column contains a null value. It is possible to explicitly define values which are interpreted as missing values.
  28. object RealType extends RealType with Product with Serializable

    Permalink
  29. object RegressionPredictor extends Serializable

    Permalink
  30. object SimpleSetPredicate extends Serializable

    Permalink
  31. object SparseMatrix extends Serializable

    Permalink
  32. object StringType extends StringType with Product with Serializable

    Permalink
  33. object StructType extends Serializable

    Permalink
  34. object Table extends Serializable

    Permalink
  35. object TimeSecondsType extends TimeSecondsType with Product with Serializable

    Permalink
  36. object TimeType extends TimeType with Product with Serializable

    Permalink
  37. object True extends Predicate

    Permalink

    Identifies the boolean constant TRUE.

  38. object UnresolvedDataType extends DataType with Product with Serializable

    Permalink
  39. object Value extends Serializable

    Permalink
  40. object chebychev extends Distance

    Permalink
  41. object cityBlock extends Distance

    Permalink
  42. object euclidean extends Distance

    Permalink
  43. object jaccard extends Distance

    Permalink
  44. object simpleMatching extends Distance

    Permalink
  45. object squaredEuclidean extends Distance

    Permalink
  46. object tanimoto extends Distance

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped