Header menu logo FSharp.Stats

Contingency Module

Functions and values

Function or value Description

as2x2 t

Full Usage: as2x2 t

Parameters:
Returns: Contingency2x2<'R, 'C>
t : Table<'R, 'C, int>
Returns: Contingency2x2<'R, 'C>

columnTotal c t

Full Usage: columnTotal c t

Parameters:
Returns: int

Sum of counts in a given column.

c : 'C
t : ContingencyTable<'R, 'C>
Returns: int

create rows cols data

Full Usage: create rows cols data

Parameters:
    rows : 'R[]
    cols : 'C[]
    data : int[]

Returns: ContingencyTable<'R, 'C>
rows : 'R[]
cols : 'C[]
data : int[]
Returns: ContingencyTable<'R, 'C>

decrement r c t

Full Usage: decrement r c t

Parameters:
Returns: Table<'R, 'C, int>

Decrement cell (r,c) by 1 (throws if it would go below zero).

r : 'R
c : 'C
t : ContingencyTable<'R, 'C>
Returns: Table<'R, 'C, int>

ensure2x2 t

Full Usage: ensure2x2 t

Parameters:
Returns: ContingencyTable<'R, 'C>

Ensure it's 2×2; throws otherwise.

t : ContingencyTable<'R, 'C>
Returns: ContingencyTable<'R, 'C>

getCount r c t

Full Usage: getCount r c t

Parameters:
Returns: int

Get the count in cell (r,c). Throws if (r,c) not a valid key.

r : 'R
c : 'C
t : ContingencyTable<'R, 'C>
Returns: int

increment r c t

Full Usage: increment r c t

Parameters:
Returns: Table<'R, 'C, int>

Increment cell (r,c) by 1.

r : 'R
c : 'C
t : ContingencyTable<'R, 'C>
Returns: Table<'R, 'C, int>

ofArray data2d

Full Usage: ofArray data2d

Parameters:
    data2d : int[,]

Returns: ContingencyTable<int, int>

Build from a 2D integer array (rows × columns), zero‐based. Throws if any entry is negative.

data2d : int[,]
Returns: ContingencyTable<int, int>

ofDataSeq rows cols data

Full Usage: ofDataSeq rows cols data

Parameters:
    rows : 'R seq
    cols : 'C seq
    data : ('R * 'C) seq

Returns: ContingencyTable<'R, 'C>

Build a ContingencyTable<'R,'C> of counts from a sequence of category‐pairs.

rows : 'R seq
cols : 'C seq
data : ('R * 'C) seq
Returns: ContingencyTable<'R, 'C>

probabilityColumnGivenRow c r t

Full Usage: probabilityColumnGivenRow c r t

Parameters:
Returns: UncertainValue

Probability of column given row.

c : 'C
r : 'R
t : ContingencyTable<'R, 'C>
Returns: UncertainValue

probabilityOf r c t

Full Usage: probabilityOf r c t

Parameters:
Returns: UncertainValue

Probability of a single cell.

r : 'R
c : 'C
t : ContingencyTable<'R, 'C>
Returns: UncertainValue

probabilityOfColumn c t

Full Usage: probabilityOfColumn c t

Parameters:
Returns: UncertainValue

Probability of a column.

c : 'C
t : ContingencyTable<'R, 'C>
Returns: UncertainValue

probabilityOfRow r t

Full Usage: probabilityOfRow r t

Parameters:
Returns: UncertainValue

Probability of a row.

r : 'R
t : ContingencyTable<'R, 'C>
Returns: UncertainValue

probabilityRowGivenColumn r c t

Full Usage: probabilityRowGivenColumn r c t

Parameters:
Returns: UncertainValue

Probability of row given column.

r : 'R
c : 'C
t : ContingencyTable<'R, 'C>
Returns: UncertainValue

rowTotal r t

Full Usage: rowTotal r t

Parameters:
Returns: int

Sum of counts in a given row.

r : 'R
t : ContingencyTable<'R, 'C>
Returns: int

setCount r c value t

Full Usage: setCount r c value t

Parameters:
Returns: Table<'R, 'C, int>

Set the count in (r,c) to a non‐negative value, returning a new table.

r : 'R
c : 'C
value : int
t : ContingencyTable<'R, 'C>
Returns: Table<'R, 'C, int>

total t

Full Usage: total t

Parameters:
Returns: int

Total count in the whole table.

t : ContingencyTable<'R, 'C>
Returns: int

zeroCreate rows cols

Full Usage: zeroCreate rows cols

Parameters:
    rows : 'R[]
    cols : 'C[]

Returns: ContingencyTable<'R, 'C>

Create a zero‐filled table for the given row & column labels.

rows : 'R[]
cols : 'C[]
Returns: ContingencyTable<'R, 'C>

Type something to start searching.