binius_math/
error.rs

1// Copyright 2024-2025 Irreducible Inc.
2
3use std::ops::Range;
4
5#[derive(Debug, thiserror::Error)]
6pub enum Error {
7	#[error("argument {arg} does not have expected length {expected}")]
8	IncorrectArgumentLength { arg: String, expected: usize },
9	#[error("the matrix is not square")]
10	MatrixNotSquare,
11	#[error("the matrix is singular")]
12	MatrixIsSingular,
13	#[error("domain size needs to be at least one")]
14	DomainSizeAtLeastOne,
15	#[error("domain size is larger than the field")]
16	DomainSizeTooLarge,
17	#[error("the inputted packed values slice had an unexpected length")]
18	InvalidPackedValuesLength,
19	#[error("remap index identifier not found in superset")]
20	RemapIdentifierNotFound,
21	#[error("duplicate point in domain")]
22	DuplicateDomainPoint,
23	#[error("expected the number of evaluations to match the domain size")]
24	ExtrapolateNumberOfEvaluations,
25	#[error("{0}")]
26	FieldError(#[from] binius_field::Error),
27	#[error("batch size mismatch - non-rectangular query shape or evals of wrong length")]
28	BatchEvaluateSizeMismatch,
29	#[error("the query must have size {expected}")]
30	IncorrectQuerySize { expected: usize },
31	#[error("Polynomial error: {0}")]
32	PolynomialError(Box<dyn std::error::Error + Send + Sync>),
33	#[error("MultilinearQuery is full, cannot update further. Has {max_query_vars} variables")]
34	MultilinearQueryFull { max_query_vars: usize },
35	#[error("argument length must be a power of two")]
36	PowerOfTwoLengthRequired,
37	#[error("argument {arg} must be in the range {range:?}")]
38	ArgumentRangeError { arg: String, range: Range<usize> },
39	#[error("logarithm of embedding degree of {log_embedding_degree} is too large.")]
40	LogEmbeddingDegreeTooLarge { log_embedding_degree: usize },
41	#[error("the polynomial is expected to have {expected} variables, and instead has {actual}")]
42	IncorrectNumberOfVariables { expected: usize, actual: usize },
43	#[error("indexed point on hypercube is out of range: index={index}")]
44	HypercubeIndexOutOfRange { index: usize },
45	#[error("the output polynomial must have size {expected}")]
46	IncorrectOutputPolynomialSize { expected: usize },
47	#[error("the total number of coefficients, {total_length}, in the piecewise multilinear is too large: {total_length} > 2^{total_n_vars}")]
48	PiecewiseMultilinearTooLong {
49		total_length: usize,
50		total_n_vars: usize,
51	},
52	#[error("there are a total of {actual} polynomials, according to n_pieces_by_vars, while you have provided evaluations for {expected}")]
53	PiecewiseMultilinearIncompatibleEvals { actual: usize, expected: usize },
54	#[error("cannot fold a constant multilinear")]
55	ConstantFold,
56	#[error("the function expects the expression to have degree at most 1")]
57	NonLinearExpression,
58}