site_name: 'Fermat - PHP Math Library'

extra_css:

- css/md-theme.css

- css/custom.css

repo_url: 'https://github.com/JordanRL/Fermat/'

site_url: 'https://jordanrl.github.io/Fermat/'

copyright: 'Copyright © 2015-2024 Jordan LeDoux'

nav:

-

Introduction:

-

'About Fermat': index.md

-

'Fermat vs. Alternatives': fermat-vs-alternatives.md

-

'Getting Started':

-

Concepts: getting-started/concepts.md

-

'Installation & Usage': getting-started/installation-and-usage.md

-

'Mutable vs. Immutable': getting-started/mutability.md

-

'Using The Factories': getting-started/using-factories.md

-

'Comparing Values': getting-started/comparing.md

-

'Handling Exceptions': getting-started/exceptions.md

-

Modules: getting-started/modules.md

-

'Use Case Guides':

-

'Scalar Replacements': getting-started/how-to-replace-scalars.md

-

Performance:

-

Overview: performance/overview.md

-

'Performance Stats':

-

Arithmetic: performance/arithmetic.md

-

Logarithms: performance/logarithms.md

-

Trigonometry: performance/trigonometry.md

-

Configuration:

-

'Calculation Modes': configuration/calculation-modes.md

-

'Random Modes': configuration/random-modes.md

-

'Rounding Modes': configuration/rounding-modes.md

-

'Base Conversion': configuration/base-conversion.md

-

Modules:

-

'Stable Modules':

-

'Coordinate Systems': modules/coordinate-systems/about.md

-

Stats: modules/stats/about.md

-

'Unstable Modules':

-

'Algebra Expressions': modules/algebra-expressions/about.md

-

'Complex Numbers': modules/complex-numbers/about.md

-

'Linear Algebra': modules/linear-algebra/about.md

-

'Source Reference':

-

'Fermat Complex':

-

'':

-

ComplexNumbers: 'roster/latest/Fermat Complex//ComplexNumbers.md'

-

Types:

-

ComplexNumber: 'roster/latest/Fermat Complex//Types/ComplexNumber.md'

-

Base:

-

Interfaces:

-

Numbers:

-

ComplexNumberInterface: 'roster/latest/Fermat Complex//Types/Base/Interfaces/Numbers/ComplexNumberInterface.md'

-

Traits:

-

ArithmeticComplexHelperTrait: 'roster/latest/Fermat Complex//Types/Traits/ArithmeticComplexHelperTrait.md'

-

ArithmeticComplexTrait: 'roster/latest/Fermat Complex//Types/Traits/ArithmeticComplexTrait.md'

-

ComplexScaleTrait: 'roster/latest/Fermat Complex//Types/Traits/ComplexScaleTrait.md'

-

Values:

-

MutableComplexNumber: 'roster/latest/Fermat Complex//Values/MutableComplexNumber.md'

-

ImmutableComplexNumber: 'roster/latest/Fermat Complex//Values/ImmutableComplexNumber.md'

-

'Fermat Linear Algebra':

-

'':

-

Types:

-

Traits:

-

ArithmeticMatrixTrait: 'roster/latest/Fermat Linear Algebra//Types/Traits/ArithmeticMatrixTrait.md'

-

Matrix:

-

DirectAccessTrait: 'roster/latest/Fermat Linear Algebra//Types/Traits/Matrix/DirectAccessTrait.md'

-

ShapeTrait: 'roster/latest/Fermat Linear Algebra//Types/Traits/Matrix/ShapeTrait.md'

-

Matrix: 'roster/latest/Fermat Linear Algebra//Types/Matrix.md'

-

Vector: 'roster/latest/Fermat Linear Algebra//Types/Vector.md'

-

Base:

-

Interfaces:

-

Groups:

-

VectorInterface: 'roster/latest/Fermat Linear Algebra//Types/Base/Interfaces/Groups/VectorInterface.md'

-

MatrixInterface: 'roster/latest/Fermat Linear Algebra//Types/Base/Interfaces/Groups/MatrixInterface.md'

-

Values:

-

ImmutableMatrix: 'roster/latest/Fermat Linear Algebra//Values/ImmutableMatrix.md'

-

MutableMatrix: 'roster/latest/Fermat Linear Algebra//Values/MutableMatrix.md'

-

Matrices: 'roster/latest/Fermat Linear Algebra//Matrices.md'

-

'Fermat Statistics':

-

'':

-

Provider:

-

StatsProvider: 'roster/latest/Fermat Statistics//Provider/StatsProvider.md'

-

Distribution:

-

Discrete:

-

Poisson: 'roster/latest/Fermat Statistics//Distribution/Discrete/Poisson.md'

-

Bernoulli: 'roster/latest/Fermat Statistics//Distribution/Discrete/Bernoulli.md'

-

Binomial: 'roster/latest/Fermat Statistics//Distribution/Discrete/Binomial.md'

-

Continuous:

-

Normal: 'roster/latest/Fermat Statistics//Distribution/Continuous/Normal.md'

-

Exponential: 'roster/latest/Fermat Statistics//Distribution/Continuous/Exponential.md'

-

Types:

-

DiscreteDistribution: 'roster/latest/Fermat Statistics//Types/DiscreteDistribution.md'

-

ContinuousDistribution: 'roster/latest/Fermat Statistics//Types/ContinuousDistribution.md'

-

Distribution: 'roster/latest/Fermat Statistics//Types/Distribution.md'

-

'Fermat Coordinates':

-

'':

-

Types:

-

Coordinate: 'roster/latest/Fermat Coordinates//Types/Coordinate.md'

-

Base:

-

Interfaces:

-

Coordinates:

-

TwoDCoordinateInterface: 'roster/latest/Fermat Coordinates//Types/Base/Interfaces/Coordinates/TwoDCoordinateInterface.md'

-

CoordinateInterface: 'roster/latest/Fermat Coordinates//Types/Base/Interfaces/Coordinates/CoordinateInterface.md'

-

ThreeDCoordinateInterface: 'roster/latest/Fermat Coordinates//Types/Base/Interfaces/Coordinates/ThreeDCoordinateInterface.md'

-

Values:

-

CylindricalCoordinate: 'roster/latest/Fermat Coordinates//Values/CylindricalCoordinate.md'

-

CartesianCoordinate: 'roster/latest/Fermat Coordinates//Values/CartesianCoordinate.md'

-

SphericalCoordinate: 'roster/latest/Fermat Coordinates//Values/SphericalCoordinate.md'

-

PolarCoordinate: 'roster/latest/Fermat Coordinates//Values/PolarCoordinate.md'

-

'Fermat Expressions':

-

'':

-

Provider:

-

SpecialPolynomials: 'roster/latest/Fermat Expressions//Provider/SpecialPolynomials.md'

-

Types:

-

Expression: 'roster/latest/Fermat Expressions//Types/Expression.md'

-

Base:

-

Interfaces:

-

Evaluateables:

-

FunctionInterface: 'roster/latest/Fermat Expressions//Types/Base/Interfaces/Evaluateables/FunctionInterface.md'

-

ExpressionInterface: 'roster/latest/Fermat Expressions//Types/Base/Interfaces/Evaluateables/ExpressionInterface.md'

-

Values:

-

Algebra:

-

ExponentialFunction: 'roster/latest/Fermat Expressions//Values/Algebra/ExponentialFunction.md'

-

PolynomialFunction: 'roster/latest/Fermat Expressions//Values/Algebra/PolynomialFunction.md'

-

'Fermat Core':

-

'':

-

Provider:

-

SeriesProvider: 'roster/latest/Fermat Core//Provider/SeriesProvider.md'

-

TrigonometryProvider: 'roster/latest/Fermat Core//Provider/TrigonometryProvider.md'

-

SequenceProvider: 'roster/latest/Fermat Core//Provider/SequenceProvider.md'

-

CalculationModeProvider: 'roster/latest/Fermat Core//Provider/CalculationModeProvider.md'

-

ArithmeticProvider: 'roster/latest/Fermat Core//Provider/ArithmeticProvider.md'

-

NumberFormatProvider: 'roster/latest/Fermat Core//Provider/NumberFormatProvider.md'

-

RoundingProvider: 'roster/latest/Fermat Core//Provider/RoundingProvider.md'

-

BaseConversionProvider: 'roster/latest/Fermat Core//Provider/BaseConversionProvider.md'

-

ConstantProvider: 'roster/latest/Fermat Core//Provider/ConstantProvider.md'

-

RandomProvider: 'roster/latest/Fermat Core//Provider/RandomProvider.md'

-

RoundingModeAdapters:

-

Modes:

-

StochasticAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/StochasticAdapter.md'

-

HalfUpAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfUpAdapter.md'

-

HalfZeroAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfZeroAdapter.md'

-

BaseAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/BaseAdapter.md'

-

HalfDownAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfDownAdapter.md'

-

CeilAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/CeilAdapter.md'

-

TruncateAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/TruncateAdapter.md'

-

HalfRandomAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfRandomAdapter.md'

-

HalfAlternatingAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfAlternatingAdapter.md'

-

HalfInfAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfInfAdapter.md'

-

FloorAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/FloorAdapter.md'

-

HalfEvenAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfEvenAdapter.md'

-

HalfOddAdapter: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/Modes/HalfOddAdapter.md'

-

ModeAdapterFactory: 'roster/latest/Fermat Core//Provider/RoundingModeAdapters/ModeAdapterFactory.md'

-

Collections: 'roster/latest/Fermat Core//Collections.md'

-

Numbers: 'roster/latest/Fermat Core//Numbers.md'

-

Types:

-

NumberCollection: 'roster/latest/Fermat Core//Types/NumberCollection.md'

-

Fraction: 'roster/latest/Fermat Core//Types/Fraction.md'

-

Tuple: 'roster/latest/Fermat Core//Types/Tuple.md'

-

Decimal: 'roster/latest/Fermat Core//Types/Decimal.md'

-

Base:

-

Number: 'roster/latest/Fermat Core//Types/Base/Number.md'

-

Interfaces:

-

Callables:

-

ContinuedFractionTermInterface: 'roster/latest/Fermat Core//Types/Base/Interfaces/Callables/ContinuedFractionTermInterface.md'

-

Groups:

-

NumberCollectionInterface: 'roster/latest/Fermat Core//Types/Base/Interfaces/Groups/NumberCollectionInterface.md'

-

Traits:

-

ArithmeticGMPTrait: 'roster/latest/Fermat Core//Types/Base/Traits/ArithmeticGMPTrait.md'

-

LogSelectionTrait: 'roster/latest/Fermat Core//Types/Base/Traits/LogSelectionTrait.md'

-

InverseTrigonometrySelectionTrait: 'roster/latest/Fermat Core//Types/Base/Traits/InverseTrigonometrySelectionTrait.md'

-

TrigonometryNativeTrait: 'roster/latest/Fermat Core//Types/Base/Traits/TrigonometryNativeTrait.md'

-

TrigonometrySelectionTrait: 'roster/latest/Fermat Core//Types/Base/Traits/TrigonometrySelectionTrait.md'

-

TrigonometryScaleTrait: 'roster/latest/Fermat Core//Types/Base/Traits/TrigonometryScaleTrait.md'

-

ArithmeticHelperSimpleTrait: 'roster/latest/Fermat Core//Types/Base/Traits/ArithmeticHelperSimpleTrait.md'

-

TrigonometryHelpersTrait: 'roster/latest/Fermat Core//Types/Base/Traits/TrigonometryHelpersTrait.md'

-

InverseTrigonometryScaleTrait: 'roster/latest/Fermat Core//Types/Base/Traits/InverseTrigonometryScaleTrait.md'

-

LogScaleTrait: 'roster/latest/Fermat Core//Types/Base/Traits/LogScaleTrait.md'

-

LogNativeTrait: 'roster/latest/Fermat Core//Types/Base/Traits/LogNativeTrait.md'

-

ArithmeticScaleTrait: 'roster/latest/Fermat Core//Types/Base/Traits/ArithmeticScaleTrait.md'

-

InverseTrigonometryNativeTrait: 'roster/latest/Fermat Core//Types/Base/Traits/InverseTrigonometryNativeTrait.md'

-

InverseTrigonometryHelpersTrait: 'roster/latest/Fermat Core//Types/Base/Traits/InverseTrigonometryHelpersTrait.md'

-

ArithmeticSelectionTrait: 'roster/latest/Fermat Core//Types/Base/Traits/ArithmeticSelectionTrait.md'

-

ArithmeticNativeTrait: 'roster/latest/Fermat Core//Types/Base/Traits/ArithmeticNativeTrait.md'

-

Traits:

-

IntegerMathTrait: 'roster/latest/Fermat Core//Types/Traits/IntegerMathTrait.md'

-

NumberNormalizationTrait: 'roster/latest/Fermat Core//Types/Traits/NumberNormalizationTrait.md'

-

SimpleArithmeticTrait: 'roster/latest/Fermat Core//Types/Traits/SimpleArithmeticTrait.md'

-

CalculationModeTrait: 'roster/latest/Fermat Core//Types/Traits/CalculationModeTrait.md'

-

ComparisonTrait: 'roster/latest/Fermat Core//Types/Traits/ComparisonTrait.md'

-

SimpleLogTrait: 'roster/latest/Fermat Core//Types/Traits/SimpleLogTrait.md'

-

SimpleInverseTrigonometryTrait: 'roster/latest/Fermat Core//Types/Traits/SimpleInverseTrigonometryTrait.md'

-

SimpleTrigonometryTrait: 'roster/latest/Fermat Core//Types/Traits/SimpleTrigonometryTrait.md'

-

Decimal:

-

ScaleTrait: 'roster/latest/Fermat Core//Types/Traits/Decimal/ScaleTrait.md'

-

FormatterTrait: 'roster/latest/Fermat Core//Types/Traits/Decimal/FormatterTrait.md'

-

Values:

-

ImmutableDecimal: 'roster/latest/Fermat Core//Values/ImmutableDecimal.md'

-

MutableFraction: 'roster/latest/Fermat Core//Values/MutableFraction.md'

-

MutableDecimal: 'roster/latest/Fermat Core//Values/MutableDecimal.md'

-

ImmutableFraction: 'roster/latest/Fermat Core//Values/ImmutableFraction.md'

theme:

palette:

-

media: '(prefers-color-scheme: light)'

scheme: default

toggle:

icon: material/toggle-switch-off-outline

name: 'Switch to dark mode'

-

media: '(prefers-color-scheme: dark)'

scheme: slate

toggle:

icon: material/toggle-switch

name: 'Switch to light mode'

name: material

features:

- navigation.sections

- navigation.top

- navigation.tabs

highlightjs: true

hljs_languages:

- php

markdown_extensions:

-

toc:

toc_depth: 5

- admonition

-

markdown_katex:

no_inline_svg: true

insert_fonts_css: true

- pymdownx.tabbed

- pymdownx.superfences

-

pymdownx.highlight:

linenums: true

linenums_style: inline

-

pymdownx.snippets:

base_path: ./docs/snippets

check_paths: true

- pymdownx.extra