named-tuples

A number of namedtuple class are used in GTC to return the results of calculations.

class VarianceAndDof(cv, df)

namedtuple: Values of the variance and degrees of freedom.

cv

Variance.

df

float: Degrees of freedom.

class VarianceCovariance(rr, ri, ir, ii)

namedtuple: Values of variance-covariance for a complex quantity

rr

float: variance in the real component

ri

float: covariance between the real and imaginary components

ir

float: covariance between the real and imaginary components

ii

float: variance in the imaginary component

class StandardUncertainty(real, imag)

namedtuple: Standard uncertainty values of a complex quantity

real

float: standard uncertainty in the real component

imag

float: standard uncertainty in the imaginary component

class StandardDeviation(real, imag)

namedtuple: Standard deviation values of a complex quantity

real

float: standard deviation in the real component

imag

float: standard deviation in the imaginary component

class ComponentOfUncertainty(rr, ri, ir, ii)

namedtuple: Component of uncertainty values for a complex quantity

rr

float: real component with respect to real component

ri

float: real component with respect to imaginary component

ir

float: imaginary component with respect to real component

ii

float: imaginary component with respect to imaginary component

class Influence(label, u, uid)

namedtuple: label, value, and identifier of a component of uncertainty

label

str: influence quantity label

u

float: component of uncertainty

uid

tuple: unique identifier of the uncertain number

Added in version 1.3.7: The attribute uid has been added

class Component(uid, u)

namedtuple: unique identifier and value of a component of uncertainty

uid

tuple: unique identifier tuple

u

float: component of uncertainty

class CovarianceMatrix(rr, ri, ir, ii)

namedtuple: Values of covariance for a pair of quantities x and y

rr

float: covariance between x.real and y.real

ri

float: covariance between x.real and y.imag

ir

float: covariance between x.imag and y.real

ii

float: covariance between x.imag and y.imag

class CorrelationMatrix(rr, ri, ir, ii)

namedtuple: Correlation coefficients for a pair of quantities x and y

rr

float: correlation between x.real and y.real

ri

float: correlation between x.real and y.imag

ir

float: correlation between x.imag and y.real

ii

float: correlation between x.imag and y.imag

class InterceptSlope(a, b)

namedtuple: Values for intercept a and slope b

a

UncertainReal: intercept

b

UncertainReal: slope

class FormattedUncertainReal(x, u, df, label)

namedtuple: The formatted representation of an UncertainReal number.

Added in version 1.4.0.

x

float: value

u

float: standard uncertainty

df

float: degrees of freedom

label

str: the label of the UncertainReal number

class FormattedUncertainComplex(x, u, r, df, label)

namedtuple: The formatted representation of an UncertainComplex number.

Added in version 1.4.0.

x

complex: value

u

StandardUncertainty: standard uncertainty

r

float: correlation coefficient between real and imaginary components

df

float: degrees of freedom

label

str: the label of the UncertainComplex number