mml

Class UPModel.Transform.M

java.lang.Object

la.la.Value

mml.Model

mml.UPModel.M

mml.UPModel.Transform.M

All Implemented Interfaces:

java.lang.Comparable<Value>

Enclosing class:

UPModel.Transform

public class UPModel.Transform.M
extends UPModel.M

The fully parameterised Transform-ed Model. That is, apply Function 'f' to datum 'd' and Model f(d) by UPModel.M. This amounts to applying the inverse, f⁻¹ to the random variable modelled by UPModel.M, e.g., log−1=exp. Statistical parameters are as per the enclosing UPModel.M being transformed. Note, there is a more specific Continuous.Transform.M for transforming (UnParameterised) Continuous Models and similar can be created for other subclasses of UPModel.M.
NB. The preferred way to transform a UPModel is with function transform(f).
Also see the related but different Model.Transform.M.

Nested Class Summary

Nested classes/interfaces inherited from class mml.Model

Model.Defaults, Model.Transform

Nested classes/interfaces inherited from class la.la.Value

Value.Atomic, Value.Bool, Value.Char, Value.Chars, Value.Cts, Value.Defer, Value.Discrete, Value.Enum, Value.Inc_Or, Value.Int, Value.Lambda, Value.List, Value.Maybe, Value.Option, Value.Real, Value.Scannable, Value.Structured, Value.Triv, Value.Tuple

Field Summary

Fields

Modifier and Type	Field and Description
Model	m 'm', the UPModel.M doing the work behind the scenes.

Fields inherited from class mml.Model

msg1, msg2, sp

Fields inherited from class la.la.Value

C, comparator, CR, E, eight, ffalse, five, fiveR, four, fourR, half, negCR, negOne, negOneR, negTenR, nilVal, nine, None, one, oneR, PI, PIby2, point01, point1, point5, point9, quarter, seven, six, ten, tenR, three, threeR, triv, ttrue, two, twoR, zero, zeroR

Constructor Summary

Constructors

Constructor and Description
M(double msg1, double msg2, Value sp) Statistical parameter(s) 'sp', as per the enclosing UPModel.M, is (are) used to create m.

Method Summary

Modifier and Type	Method and Description
double	nlLH(Value ss) Use m on transformed data, m.nlLH(ss), but note that statistics ss comes from stats.
double	nlPr(Value d) Use m on transformed data, m.nlPr(f(d)).
double	pr(Value d) Use m on transformed data, m.pr(f(d)).
Value	random() Get a random() from m and apply f−1 to it if f has an inverse implemented.
Value	stats(boolean add, Value ss0, Value ss1) Combine statistics 'ss0' and 'ss1' as m does.
Value	stats(Vector ds, int lo, int hi) m.stats(ds.map(f),...), i.e., m's stats on transformed data.
java.lang.String	toString() Return a String representation of 'this' fully parameterised Model.

Methods inherited from class mml.UPModel.M

asGiven, asGiven

Methods inherited from class mml.Model

asEstimator, asUPModel, m1m2sp, msg, msg1, msg1bits, msg2, msg2bits, msgBits, nl2LH, nl2Pr, random, randomSeries, statParams, stats, stats, sumNlPr, transform, type, zeroTriv

Methods inherited from class la.la.Value

AoM, apply, bOp, compareTo, cons, cts, elt, errMsg, error, force, isTuple, just, main, n, nElts, nlAoM, pair, print, quad, real, RTE, triple, tuple, UOE, uOp, x

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m

public final Model m

'm', the UPModel.M doing the work behind the scenes.

Constructor Detail

M

public M(double msg1,
         double msg2,
         Value sp)

Statistical parameter(s) 'sp', as per the enclosing UPModel.M, is (are) used to create m.

Method Detail

nlPr

public double nlPr(Value d)

Use m on transformed data, m.nlPr(f(d)).

Specified by:

nlPr in class Model

pr

public double pr(Value d)

Use m on transformed data, m.pr(f(d)).

Overrides:

pr in class Model

nlLH

public double nlLH(Value ss)

Use m on transformed data, m.nlLH(ss), but note that statistics ss comes from stats.

Specified by:

nlLH in class Model

stats

public Value stats(Vector ds,
                   int lo,
                   int hi)

m.stats(ds.map(f),...), i.e., m's stats on transformed data. Also see nlLH(ss).

Overrides:

stats in class UPModel.M

stats

public Value stats(boolean add,
                   Value ss0,
                   Value ss1)

Combine statistics 'ss0' and 'ss1' as m does.

Overrides:

stats in class UPModel.M

random

public Value random()

Get a random() from m and apply f⁻¹ to it if f has an inverse implemented.

Overrides:

random in class Model

toString

public java.lang.String toString()

Description copied from class: UPModel.M

Return a String representation of 'this' fully parameterised Model. The result includes the enclosing UnParameterised Model, with its problem defining parameters, and 'this' M-Model's statistical parameter(s).

Overrides:

toString in class UPModel.M