_Rank

it.grypho.scala.leonardo.matrix._Rank
case class _Rank(m: _Expression, tol: Option[_Expression] = ...) extends _Expression

Numerical rank: rank(A) or rank(A, tol) — the number of singular values above tol·σ_max (F_0061 Decision B).

The default tol is 0.5·10⁻ᵖ at session precision p; an explicit one is relative to the largest singular value too, so rank(k·A, tol) never depends on k. It must be a number in [0, 1); anything else stays unevaluated. The zero matrix has rank 0. A SCALAR result, so this does not extend _MatrixOperation (the det rule). The count is built in the operand's tier — an exact matrix answers an exact integer — although the decomposition behind it is Double.

Value parameters

m

the matrix expression

tol

the optional relative tolerance

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait _Expression
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def children: List[_Expression]

Sub-expressions subject to recursive structural traversal. Binder positions (e.g. the differentiation variable) are excluded.

Sub-expressions subject to recursive structural traversal. Binder positions (e.g. the differentiation variable) are excluded.

Attributes

Definition Classes
def declineReason(env: Environment): Option[String]

Why this call stays unevaluated: a tolerance that is a number outside [0, 1), or a real matrix refused by the decomposition (see svdDecline).

Why this call stays unevaluated: a tolerance that is a number outside [0, 1), or a real matrix refused by the decomposition (see svdDecline).

Value parameters

env

the evaluation environment

Attributes

Returns

the reason, or None

override def eval(env: Environment): Either[_Expression, _Value]

Reduces this expression in the given environment.

Reduces this expression in the given environment.

Value parameters

env

variable bindings and display precision

Attributes

Returns

Right(v) when all free variables resolved to concrete values; Left(e) when reduction is partial or impossible

Definition Classes
override def rebuild(c: List[_Expression]): _Expression

Reconstructs the same node shape with replacement sub-expressions.

Reconstructs the same node shape with replacement sub-expressions.

Value parameters

newChildren

replacements in the same order and count as children

Attributes

Definition Classes
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Inherited fields

lazy val freeVars: Set[String]

Cached set of free variable names; O(1) after the first access.

Cached set of free variable names; O(1) after the first access.

Attributes

Inherited from:
_Expression