Skip to content
Symi Docs
Python
On this page

Statistics

Symbolic probability distributions, joint laws, and random-variable algebra. A distribution node names a parametrised family; a random variable node names a draw from a distribution. Distinct draws are not independent unless they share an explicit independent-product law. The complete distribution registry lists every accepted family, its ordered parameters, support, and closed-form operations. The canonical names for the gamma and beta families are gamma_distribution and beta_distribution.

distribution#

Default context

distribution(
    name: str,
    parameters: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.distribution

distribution(
    name: str,
    parameters: Iterable[ExpressionLike],
) -> Expression

Build a distribution node from a family name and its ordered parameter list (e.g. distribution("normal", [mean, standard_deviation])). An unknown name raises an invalid-option error. A parameter count that does not match the family's arity raises a collection-shape error; it does not create an undefined mathematical value.

random_variable#

Default context

random_variable(name: str, distribution: ExpressionLike) -> Expression
Calling forms

Explicit context: Context.random_variable

random_variable(name: str, distribution: ExpressionLike) -> Expression

Build a random variable named name drawn from distribution. Each call creates a distinct coordinate identity, even when its display name is reused.

multivariate_normal#

Default context

multivariate_normal(
    mean: Iterable[ExpressionLike],
    covariance: Matrix,
) -> Expression
Calling forms

Explicit context: Context.multivariate_normal

multivariate_normal(
    mean: Iterable[ExpressionLike],
    covariance: Matrix,
) -> Expression

Construct an ordinary multivariate normal law from an ordered real mean vector and a symmetric positive-definite covariance matrix.

multinomial_distribution#

Default context

multinomial_distribution(
    trial_count: ExpressionLike,
    probabilities: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.multinomial_distribution

multinomial_distribution(
    trial_count: ExpressionLike,
    probabilities: Iterable[ExpressionLike],
) -> Expression

Construct a multinomial law from a nonnegative integer trial count and ordered category probabilities summing exactly to one.

dirichlet#

Default context

dirichlet(parameters: Iterable[ExpressionLike]) -> Expression
Calling forms

Explicit context: Context.dirichlet

dirichlet(parameters: Iterable[ExpressionLike]) -> Expression

Construct a Dirichlet law. Its density is relative to intrinsic simplex measure, not ambient Euclidean Lebesgue measure.

independent_product#

Default context

independent_product(factors: Iterable[ExpressionLike]) -> Expression
Calling forms

Explicit context: Context.independent_product

independent_product(factors: Iterable[ExpressionLike]) -> Expression

Construct the joint product law that explicitly certifies independence.

discrete_markov_chain#

Default context

discrete_markov_chain(
    name: Any,
    states: Any,
    transition_matrix: Any,
    initial_probabilities: Any,
) -> Expression
Calling forms

Explicit context: Context.discrete_markov_chain

discrete_markov_chain(
    name: Any,
    states: Any,
    transition_matrix: Any,
    initial_probabilities: Any,
) -> Expression

Construct a finite-state time-homogeneous Markov chain with ordered distinct state labels, an exact row-stochastic transition matrix, and an exact initial row law.

transition_probability#

Default context

transition_probability(
    process: Any,
    from_state: Any,
    to_state: Any,
    start_index: Any,
    end_index: Any,
) -> Expression
Calling forms

Explicit context: Context.transition_probability

transition_probability(
    process: Any,
    from_state: Any,
    to_state: Any,
    start_index: Any,
    end_index: Any,
) -> Expression

Return the exact finite-horizon transition probability for a finite Markov chain. The horizon must be a proved nonnegative integer.

stationary_distributions#

Default context

stationary_distributions(process: Any) -> Matrix
Calling forms

Explicit context: Context.stationary_distributions

stationary_distributions(process: Any) -> Matrix

Return one row for every extreme stationary law. All stationary laws are the convex combinations of these rows in the process state order.

hitting_probability#

Default context

hitting_probability(
    process: Any,
    start_state: Any,
    target_states: Any,
) -> Expression
Calling forms

Explicit context: Context.hitting_probability

hitting_probability(
    process: Any,
    start_state: Any,
    target_states: Any,
) -> Expression

Return the exact probability that the chain ever reaches one of the target states from start_state.

expected_hitting_time#

Default context

expected_hitting_time(
    process: Any,
    start_state: Any,
    target_states: Any,
) -> Expression
Calling forms

Explicit context: Context.expected_hitting_time

expected_hitting_time(
    process: Any,
    start_state: Any,
    target_states: Any,
) -> Expression

Return the exact expected time to reach a target state set. The result is positive infinity when the target is not reached almost surely.

affine_process_transformation#

Default context

affine_process_transformation(
    name: Any,
    source: Any,
    multiplier: Any,
    offset: Any,
) -> Expression
Calling forms

Explicit context: Context.affine_process_transformation

affine_process_transformation(
    name: str,
    source: ExpressionLike,
    multiplier: ExpressionLike,
    offset: ExpressionLike,
) -> Expression

Construct the pointwise affine image offset + multiplier * source of a certified Gaussian process.

independent_gaussian_process_sum#

Default context

independent_gaussian_process_sum(
    name: Any,
    first_source: Any,
    second_source: Any,
) -> Expression
Calling forms

Explicit context: Context.independent_gaussian_process_sum

independent_gaussian_process_sum(
    name: str,
    first_source: ExpressionLike,
    second_source: ExpressionLike,
) -> Expression

Construct the pointwise sum of two explicitly independent Gaussian processes on the same index domain.

finite_dimensional_random_vector#

Default context

finite_dimensional_random_vector(
    process: Any,
    indices: Any,
    coordinate_names: Any,
) -> Expression
Calling forms

Explicit context: Context.finite_dimensional_random_vector

finite_dimensional_random_vector(
    process: ExpressionLike,
    indices: Iterable[ExpressionLike],
    coordinate_names: list[str],
) -> Expression

Construct the ordered random-vector handle for a finite process slice, using the shared joint-law and conditioning operations.

conditional_process_slice_distribution#

Default context

conditional_process_slice_distribution(
    process: Any,
    selected_indices: Any,
    conditioning_indices: Any,
    conditioning_values: Any,
) -> Expression
Calling forms

Explicit context: Context.conditional_process_slice_distribution

conditional_process_slice_distribution(
    process: ExpressionLike,
    selected_indices: Iterable[ExpressionLike],
    conditioning_indices: Iterable[ExpressionLike],
    conditioning_values: Iterable[ExpressionLike],
) -> Expression

Condition an ordered finite process slice on another ordered slice at explicit values through the shared continuous conditional-law engine. The operation declines or remains unevaluated when the conditioning marginal has no certified density.

independent_process_product#

Default context

independent_process_product(
    first_process: Any,
    first_indices: Any,
    second_process: Any,
    second_indices: Any,
) -> Expression
Calling forms

Explicit context: Context.independent_process_product

independent_process_product(
    first_process: ExpressionLike,
    first_indices: Iterable[ExpressionLike],
    second_process: ExpressionLike,
    second_indices: Iterable[ExpressionLike],
) -> Expression

Construct the explicit block-independent joint law of two finite process slices.

product_copula#

Default context

product_copula(marginals: Iterable[ExpressionLike]) -> Expression
Calling forms

Explicit context: Context.product_copula

product_copula(marginals: Iterable[ExpressionLike]) -> Expression

Construct the product copula of at least two continuous marginals with exact CDF and density descriptors. The result is the certified independent product law.

gaussian_copula#

Default context

gaussian_copula(
    marginals: Iterable[ExpressionLike],
    correlation: Matrix,
) -> Expression
Calling forms

Explicit context: Context.gaussian_copula

gaussian_copula(
    marginals: Iterable[ExpressionLike],
    correlation: Matrix,
) -> Expression

Construct a Gaussian copula from continuous marginals and a symmetric positive-semidefinite unit-diagonal correlation matrix. Its density remains unevaluated unless the system gains an exact normal-quantile representation.

archimedean_copula#

Default context

archimedean_copula(
    family: str,
    marginals: Any,
    parameter: Any,
) -> Expression
Calling forms

Explicit context: Context.archimedean_copula

archimedean_copula(
    family: str,
    marginals: Iterable[ExpressionLike],
    parameter: ExpressionLike,
) -> Expression

Construct a Clayton, Frank, or Gumbel copula from continuous marginals. The parameter domain is checked exactly; arbitrary generator expressions are not accepted as copulas.

estimate_archimedean_copula_parameter#

Default context

estimate_archimedean_copula_parameter(
    family: str,
    observations: Any,
) -> Expression
Calling forms

Explicit context: Context.estimate_archimedean_copula_parameter

estimate_archimedean_copula_parameter(
    family: str,
    observations: Matrix,
) -> Expression

Estimate a Clayton or Gumbel parameter by exactly inverting bivariate Kendall's tau. Observations must have exactly two columns and every pairwise order must be exact and strict, so ties and undecidable comparisons decline.

estimate_archimedean_copula_parameter_numeric#

Default context

estimate_archimedean_copula_parameter_numeric(
    family: str,
    observations: Any,
    parameter: Any,
    lower: Any,
    upper: Any,
    significant_digits: Any = ...,
    accuracy: Any = ...,
    maximum_precision_bits: Any = ...,
    work_budget: Any = ...,
) -> NumericRootFindingResult
Calling forms

Explicit context: Context.estimate_archimedean_copula_parameter_numeric

estimate_archimedean_copula_parameter_numeric(
    family: str,
    observations: Matrix,
    parameter: VariableLike,
    lower: Any,
    upper: Any,
    significant_digits: Any = ...,
    accuracy: Any = ...,
    maximum_precision_bits: Any = ...,
    work_budget: Any = ...,
) -> NumericRootFindingResult

Explicitly request bracketed numerical Frank-parameter estimation. A result is returned only when the requested bracket and every needed numerical kernel can be certified; otherwise its typed decline explains why.

quantile_numeric#

Default context

quantile_numeric(
    distribution: ExpressionLike,
    probability: Any,
    variable: Any,
    lower: Any,
    upper: Any,
    significant_digits: Any = ...,
    accuracy: Any = ...,
    maximum_precision_bits: Any = ...,
    work_budget: Any = ...,
) -> NumericRootFindingResult
Calling forms

Explicit context: Context.quantile_numeric

quantile_numeric(
    distribution: ExpressionLike,
    probability: ExpressionLike,
    variable: VariableLike,
    lower: Any,
    upper: Any,
    significant_digits: Any = ...,
    accuracy: Any = ...,
    maximum_precision_bits: Any = ...,
    work_budget: Any = ...,
) -> NumericRootFindingResult

Explicitly invert a scalar continuous CDF on an exact rational bracket. Symbolic probability operations never invoke this numerical operation implicitly.

order_statistic#

Default context

order_statistic(
    base_law: ExpressionLike,
    sample_size: ExpressionLike,
    rank: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.order_statistic

order_statistic(
    base_law: ExpressionLike,
    sample_size: ExpressionLike,
    rank: ExpressionLike,
) -> Expression

Construct the rank order statistic of an i.i.d. sample from a scalar law. Both sample size and rank must be positive exact integers, and rank cannot exceed sample size.

minimum#

Default context

minimum(
    base_law: ExpressionLike,
    sample_size: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.minimum

minimum(
    base_law: ExpressionLike,
    sample_size: ExpressionLike,
) -> Expression

Construct the smallest member of an i.i.d. sample from a scalar law.

maximum#

Default context

maximum(
    base_law: ExpressionLike,
    sample_size: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.maximum

maximum(
    base_law: ExpressionLike,
    sample_size: ExpressionLike,
) -> Expression

Construct the largest member of an i.i.d. sample from a scalar law.

random_vector#

Default context

random_vector(
    coordinate_names: list[str],
    joint_distribution: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.random_vector

random_vector(
    coordinate_names: list[str],
    joint_distribution: ExpressionLike,
) -> Expression

Construct an ordered vector of fresh coordinate handles for a joint law.

joint_distribution#

Default context

joint_distribution(random_vector: ExpressionLike) -> Expression
Calling forms

Explicit context: Context.joint_distribution

joint_distribution(random_vector: ExpressionLike) -> Expression

Return a random vector's joint law.

component#

Default context

component(random_vector: ExpressionLike, position: int) -> Expression
Calling forms

Explicit context: Context.component

component(random_vector: ExpressionLike, position: int) -> Expression

Select one coordinate by zero-based position.

marginal#

Default context

marginal(
    joint_distribution: ExpressionLike,
    positions: list[int],
) -> Expression
Calling forms

Explicit context: Context.marginal

marginal(
    joint_distribution: ExpressionLike,
    positions: list[int],
) -> Expression

Return the distinct ordered coordinate projection of a joint law.

permute#

Default context

permute(
    joint_distribution: ExpressionLike,
    permutation: list[int],
) -> Expression
Calling forms

Explicit context: Context.permute

permute(
    joint_distribution: ExpressionLike,
    permutation: list[int],
) -> Expression

Reorder every coordinate by a permutation.

joint_density#

Default context

joint_density(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.joint_density

joint_density(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression

Evaluate an ordinary joint density at an ordered point. Laws without an ordinary density retain an unevaluated query.

intrinsic_simplex_density#

Default context

intrinsic_simplex_density(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.intrinsic_simplex_density

intrinsic_simplex_density(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression

Evaluate a Dirichlet density relative to its intrinsic simplex measure.

joint_probability_mass_function#

Default context

joint_probability_mass_function(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.joint_probability_mass_function

joint_probability_mass_function(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression

Evaluate a joint point mass at an ordered point.

joint_cumulative_distribution#

Default context

joint_cumulative_distribution(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.joint_cumulative_distribution

joint_cumulative_distribution(
    joint_distribution: ExpressionLike,
    points: Iterable[ExpressionLike],
) -> Expression

Evaluate the lower-orthant cumulative distribution at an ordered point.

joint_rectangle_probability#

Default context

joint_rectangle_probability(
    joint_distribution: ExpressionLike,
    lower_bounds: Iterable[ExpressionLike],
    upper_bounds: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.joint_rectangle_probability

joint_rectangle_probability(
    joint_distribution: ExpressionLike,
    lower_bounds: Iterable[ExpressionLike],
    upper_bounds: Iterable[ExpressionLike],
) -> Expression

Evaluate the ordered rectangle probability (lower, upper].

joint_support#

Default context

joint_support(joint_distribution: ExpressionLike) -> Expression
Calling forms

Explicit context: Context.joint_support

joint_support(joint_distribution: ExpressionLike) -> Expression

Return the exact support of a joint law when available.

joint_raw_moment#

Default context

joint_raw_moment(
    joint_distribution: ExpressionLike,
    orders: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.joint_raw_moment

joint_raw_moment(
    joint_distribution: ExpressionLike,
    orders: Iterable[ExpressionLike],
) -> Expression

Return an exact multi-index raw moment when known.

joint_mean#

Default context

joint_mean(joint_distribution: ExpressionLike) -> list[Expression]
Calling forms

Explicit context: Context.joint_mean

joint_mean(joint_distribution: ExpressionLike) -> list[Expression]

Return the ordered exact mean entries of a joint law.

joint_covariance_matrix#

Default context

joint_covariance_matrix(joint_distribution: ExpressionLike) -> Matrix
Calling forms

Explicit context: Context.joint_covariance_matrix

joint_covariance_matrix(joint_distribution: ExpressionLike) -> Matrix

Return the exact covariance matrix of a joint law.

joint_correlation_matrix#

Default context

joint_correlation_matrix(joint_distribution: ExpressionLike) -> Matrix
Calling forms

Explicit context: Context.joint_correlation_matrix

joint_correlation_matrix(joint_distribution: ExpressionLike) -> Matrix

Return the correlation matrix when coordinate variances are proved positive.

density#

Default context

density(
    random_variable: ExpressionLike,
    point: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.density

density(
    random_variable: ExpressionLike,
    point: ExpressionLike,
) -> Expression

Probability density (continuous families) or probability mass (discrete families) of random_variable evaluated at point. Falls back to an unevaluated structural form when no closed form exists.

cumulative_distribution#

Default context

cumulative_distribution(
    random_variable: ExpressionLike,
    point: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.cumulative_distribution

cumulative_distribution(
    random_variable: ExpressionLike,
    point: ExpressionLike,
) -> Expression

Cumulative distribution function of random_variable evaluated at point.

expectation#

Default context

expectation(
    target: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.expectation

expectation(
    target: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression

Expectation of target over the listed independent random variables. Linearity and the constant-factor lift are applied; bare and power-of-random-variable leaves consume the distribution's mean and raw moments.

variance#

Default context

variance(
    target: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.variance

variance(
    target: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression

Variance of target over the listed independent random variables.

covariance#

Default context

covariance(
    left: ExpressionLike,
    right: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.covariance

covariance(
    left: ExpressionLike,
    right: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression

Covariance of left and right over the listed independent random variables; zero for independent operands.

probability#

Default context

probability(
    predicate: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression
Calling forms

Explicit context: Context.probability

probability(
    predicate: ExpressionLike,
    random_variables: Iterable[ExpressionLike],
) -> Expression

Probability that predicate (a tail comparison such as X > t) holds over the listed independent random variables.

moment#

Default context

moment(
    random_variable: ExpressionLike,
    order: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.moment

moment(
    random_variable: ExpressionLike,
    order: ExpressionLike,
) -> Expression

The order-th raw moment E[X^order] of random_variable.

cumulant#

Default context

cumulant(
    random_variable: ExpressionLike,
    order: ExpressionLike,
) -> Expression
Calling forms

Explicit context: Context.cumulant

cumulant(
    random_variable: ExpressionLike,
    order: ExpressionLike,
) -> Expression

The order-th cumulant of random_variable.

moment_generating_function#

Default context

moment_generating_function(
    random_variable: ExpressionLike,
    auxiliary_variable: VariableLike,
) -> Expression
Calling forms

Explicit context: Context.moment_generating_function

moment_generating_function(
    random_variable: ExpressionLike,
    auxiliary_variable: VariableLike,
) -> Expression

Closed-form moment generating function M_X(t) of random_variable in the named auxiliary variable, when elementary; otherwise an unevaluated structural form.

characteristic_function#

Default context

characteristic_function(
    random_variable: ExpressionLike,
    auxiliary_variable: VariableLike,
) -> Expression
Calling forms

Explicit context: Context.characteristic_function

characteristic_function(
    random_variable: ExpressionLike,
    auxiliary_variable: VariableLike,
) -> Expression

Closed-form characteristic function φX(t)\varphi_X(t) of random_variable in the named auxiliary variable, when elementary; otherwise an unevaluated structural form.

Example#

Build a random variable, then read its exact moments.

Python
import symi

x = symi.symbol("x")
mean = symi.symbol("mean")
deviation = symi.symbol("deviation", positive=True)

variable = symi.random_variable(
    "measurement", symi.distribution("normal", [mean, deviation])
)

print(symi.density(variable, x))
print(symi.expectation(variable, [variable]))
print(symi.variance(variable, [variable]))

Symi documentation · Python