mml

Class Multinomial

java.lang.Object

la.la.Value

la.la.Function

la.la.Function.Native

mml.UPModel

mml.UPFunctionModel

mml.Multinomial

All Implemented Interfaces:

java.lang.Comparable<Value>

public class Multinomial
extends UPFunctionModel

An UnParameterised FunctionModel, given a number of categories 'k', from a number of trials 'n' to a Vector of 'k' frequencies that sum to 'n'. The fully parameterised model is Multinomial.M. For example, if Party = {Lib, NP, Lab, Green} then k=4. An opinion poll, say, samples n people (trials) getting four frequencies that add up to n. Given a data-set of several opinion polls (possibly with different values for n) a fully parameterised Multinomial.M can be estimated. The latter FunctionModel returns the probability of a set frequencies, such as {350, 100, 400, 150}, given n = 1000, say. Also see MultiState.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Multinomial.M The fully parameterised FunctionModel from a number of trials 'n' to a Vector of 'k' frequencies that sum to 'n'.

Nested classes/interfaces inherited from class mml.UPFunctionModel

UPFunctionModel.Est, UPFunctionModel.K

Nested classes/interfaces inherited from class mml.UPModel

UPModel.Transform

Nested classes/interfaces inherited from class la.la.Function.Native

Function.Native.WithInverse

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

Function.Cts2Cts, Function.Cts2Cts2Cts, Function.CtsD2CtsD, Function.HasInverse, Function.Native, Function.Native2, Function.Native3

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
int	k The number of categories 'k'.

Fields inherited from class mml.UPModel

dp

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
Multinomial(Value k) Problem definition parameter 'k' > 0 is the number of categories.

Method Summary

Modifier and Type	Method and Description
UPFunctionModel.Est	estimator(Value ps) Return an Estimator of a Multinomial.M; parameter 'ps' is 'triv', '( )'.
Multinomial.M	sp2Model(double msg1, double msg2, Value sp) Given two-part message lengths, msg1 and msg2, and statistical parameter(s), sp, return a fully parameterised Function Model.
Value	stats(boolean add, Value ss0, Value ss1) Combine sufficient statisticses 'ss0' and 'ss1' additively (add=true), or remove ss1 from ss0 (add=false).
Value	stats(Vector ds, int lo, int hi) Stats 'ss' is just the data-set ds[lo,hi).

Methods inherited from class mml.UPFunctionModel

apply

Methods inherited from class mml.UPModel

defnParams, main, stats, stats, toString, transform

Methods inherited from class la.la.Function

bOp, fromBop, fromUop, type, uOp

Methods inherited from class la.la.Value

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

Methods inherited from class java.lang.Object

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

Field Detail

k

public final int k

The number of categories 'k'.

Constructor Detail

Multinomial

public Multinomial(Value k)

Problem definition parameter 'k' > 0 is the number of categories.

Method Detail

stats

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

Stats 'ss' is just the data-set ds[lo,hi). (One could maybe do slightly better.)

Specified by:

stats in class UPModel

stats

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

Description copied from class: UPModel

Combine sufficient statisticses 'ss0' and 'ss1' additively (add=true), or remove ss1 from ss0 (add=false). Also see stats(ds,lo,hi).

Specified by:

stats in class UPModel

sp2Model

public Multinomial.M sp2Model(double msg1,
                              double msg2,
                              Value sp)

Description copied from class: UPFunctionModel

Given two-part message lengths, msg1 and msg2, and statistical parameter(s), sp, return a fully parameterised Function Model.

Specified by:

sp2Model in class UPFunctionModel

estimator

public UPFunctionModel.Est estimator(Value ps)

Return an Estimator of a Multinomial.M; parameter 'ps' is 'triv', '( )'.

Overrides:

estimator in class UPModel