package reedsolomon

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package reedsolomon

reedsolomon
- Reedsolomon
  - Codec
    
    ATSC
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    BBCTest
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    CCSDS
    
    Rs16
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    Rs8
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    DVB
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    G709
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    MakePoly
    
    G
    
    M
    
    Row
    
    P
    
    R
    
    Sarwate
    
    MakeStandard
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
    
    RsParams
    
    RsPoly
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Standard
    
    G
    
    Gp
    
    R
    
    M
    
    Row
    
    R
    
    Sarwate
    
    Rp
  - Galois
    
    Extension
    
    Generator
    
    Poly
    
    Make
    
    G
    
    Poly
    
    GF2N
    
    Make
    
    P
    
    Primitive
    
    GF2
    
    GFN
    
    GF_n
    
    GF_n
    
    Table
    
    Generator
    
    Ops
    
    Int
    
    Ops
    
    Make
    
    G
    
    Ops
    
    MakeInt
    
    P
    
    Ops
    
    Params
    
    Ops
    
    P
  - Iter
  - Matrix
    
    Make
    
    Ops
    
    Row
    
    S
    
    Row
  - Ops
    
    Float
    
    Int
    
    Int32
    
    Int64
    
    OpsBase
    
    OpsFull
  - Poly
    
    Make
    
    E
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Basic polynomial representations. Coefficients are members of Ops.OpsBase (which effectively provide '+' and '*')

Parameters

module E : Ops.OpsBase

Signature

type elt = E.t

polynomial coefficient type

an array of 'elt's representing the polynomial. powers are at index position (ie lowest first)

type t = E.t array

an array of 'elt's representing the polynomial. powers are at index position (ie lowest first)

val degree : t -> int

the degree of the polynomial

this is represented as |E.zero|

val zero : t

this is represented as |E.zero|

this is represented as |E.one|

val one : t

this is represented as |E.one|

this is represented as |E.zero;E.one|

val x : t

this is represented as |E.zero;E.one|

convert to poly

val to_poly : elt array -> t

convert to poly

convert from poly

val of_poly : t -> elt array

convert from poly

make a copy of the poly

val copy : t -> t

make a copy of the poly

type poly_format = {

coef : elt -> string;
indet : int -> string;

}

control over print formatting

val poly_format : poly_format

val string_format : bool -> poly_format -> int -> elt -> string

val to_string : ?down:bool -> ?str:(int -> elt -> string) -> t -> string

create string of poly

val trim : t -> t

legalise the poly. high order powers which are 0 are removed.

val slice : t -> int -> t

val (+:) : t -> t -> t

poly addition

poly subtraction

val (-:) : t -> t -> t

poly subtraction

poly multiplication

val (*:) : t -> t -> t

poly multiplication

poly division

val (/:) : t -> t -> t * t

poly division

scalar multiplication

val (*:.) : t -> elt -> t

scalar multiplication

scalar division

val (/:.) : t -> elt -> t

scalar division

multiply poly by x^n

val (^:) : t -> int -> t

multiply poly by x^n

raise poly to power n

val (**:) : t -> int -> t

raise poly to power n

val ext_gcd : t -> t -> t * t

extended gcd algorithm

val eval : t -> elt -> elt

evaluate polynomial