diff --git a/api/MathNet.Numerics.Differentiation/FiniteDifferenceCoefficients.htm b/api/MathNet.Numerics.Differentiation/FiniteDifferenceCoefficients.htm index b10f5a4f..27e40237 100644 --- a/api/MathNet.Numerics.Differentiation/FiniteDifferenceCoefficients.htm +++ b/api/MathNet.Numerics.Differentiation/FiniteDifferenceCoefficients.htm @@ -286,7 +286,7 @@ diff --git a/api/MathNet.Numerics.Differentiation/NumericalDerivative.htm b/api/MathNet.Numerics.Differentiation/NumericalDerivative.htm index 40bf35ab..983d2127 100644 --- a/api/MathNet.Numerics.Differentiation/NumericalDerivative.htm +++ b/api/MathNet.Numerics.Differentiation/NumericalDerivative.htm @@ -540,7 +540,7 @@ h is approximately equal to the square-root of machine accuracy, epsilon. diff --git a/api/MathNet.Numerics.Differentiation/NumericalHessian.htm b/api/MathNet.Numerics.Differentiation/NumericalHessian.htm index 0b10a0ad..f1d7c759 100644 --- a/api/MathNet.Numerics.Differentiation/NumericalHessian.htm +++ b/api/MathNet.Numerics.Differentiation/NumericalHessian.htm @@ -314,7 +314,7 @@ The function mirrors the Hessian along the diagonal since d2f/dxdy = d2f/dydx fo diff --git a/api/MathNet.Numerics.Differentiation/NumericalJacobian.htm b/api/MathNet.Numerics.Differentiation/NumericalJacobian.htm index d04817ac..bfc638ec 100644 --- a/api/MathNet.Numerics.Differentiation/NumericalJacobian.htm +++ b/api/MathNet.Numerics.Differentiation/NumericalJacobian.htm @@ -363,7 +363,7 @@ added efficiency. This method also assumes that the length of vector x consisten diff --git a/api/MathNet.Numerics.Differentiation/StepType.htm b/api/MathNet.Numerics.Differentiation/StepType.htm index 0d3640f5..ae30b4c9 100644 --- a/api/MathNet.Numerics.Differentiation/StepType.htm +++ b/api/MathNet.Numerics.Differentiation/StepType.htm @@ -338,7 +338,7 @@ input parameter. Although implementation may vary, an example of second order ac diff --git a/api/MathNet.Numerics.Differentiation/index.htm b/api/MathNet.Numerics.Differentiation/index.htm index da2e0609..5f54c99b 100644 --- a/api/MathNet.Numerics.Differentiation/index.htm +++ b/api/MathNet.Numerics.Differentiation/index.htm @@ -159,7 +159,7 @@ diff --git a/api/MathNet.Numerics.Distributions/Bernoulli.htm b/api/MathNet.Numerics.Distributions/Bernoulli.htm index bcaf24bb..74ed02fa 100644 --- a/api/MathNet.Numerics.Distributions/Bernoulli.htm +++ b/api/MathNet.Numerics.Distributions/Bernoulli.htm @@ -800,7 +800,7 @@ p specifies the probability that a 1 is generated.. diff --git a/api/MathNet.Numerics.Distributions/Beta.htm b/api/MathNet.Numerics.Distributions/Beta.htm index 74bb6504..77e00052 100644 --- a/api/MathNet.Numerics.Distributions/Beta.htm +++ b/api/MathNet.Numerics.Distributions/Beta.htm @@ -882,7 +882,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/BetaBinomial.htm b/api/MathNet.Numerics.Distributions/BetaBinomial.htm index cb6b44c0..20026cfd 100644 --- a/api/MathNet.Numerics.Distributions/BetaBinomial.htm +++ b/api/MathNet.Numerics.Distributions/BetaBinomial.htm @@ -796,7 +796,7 @@ It is frequently used in Bayesian statistics, empirical Bayes methods and classi diff --git a/api/MathNet.Numerics.Distributions/BetaScaled.htm b/api/MathNet.Numerics.Distributions/BetaScaled.htm index 7e711886..23e7bd53 100644 --- a/api/MathNet.Numerics.Distributions/BetaScaled.htm +++ b/api/MathNet.Numerics.Distributions/BetaScaled.htm @@ -966,7 +966,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Binomial.htm b/api/MathNet.Numerics.Distributions/Binomial.htm index 2d235f6b..562dd7a4 100644 --- a/api/MathNet.Numerics.Distributions/Binomial.htm +++ b/api/MathNet.Numerics.Distributions/Binomial.htm @@ -832,7 +832,7 @@ For details about this distribution, see.
diff --git a/api/MathNet.Numerics.Distributions/Burr.htm b/api/MathNet.Numerics.Distributions/Burr.htm index 5e615bf1..108f927e 100644 --- a/api/MathNet.Numerics.Distributions/Burr.htm +++ b/api/MathNet.Numerics.Distributions/Burr.htm @@ -776,7 +776,7 @@ diff --git a/api/MathNet.Numerics.Distributions/Categorical.htm b/api/MathNet.Numerics.Distributions/Categorical.htm index 28323c51..ce072ea2 100644 --- a/api/MathNet.Numerics.Distributions/Categorical.htm +++ b/api/MathNet.Numerics.Distributions/Categorical.htm @@ -1059,7 +1059,7 @@ at the given probability. diff --git a/api/MathNet.Numerics.Distributions/Cauchy.htm b/api/MathNet.Numerics.Distributions/Cauchy.htm index a9b12f5c..f10d2f8b 100644 --- a/api/MathNet.Numerics.Distributions/Cauchy.htm +++ b/api/MathNet.Numerics.Distributions/Cauchy.htm @@ -881,7 +881,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Chi.htm b/api/MathNet.Numerics.Distributions/Chi.htm index b4df894c..195492c7 100644 --- a/api/MathNet.Numerics.Distributions/Chi.htm +++ b/api/MathNet.Numerics.Distributions/Chi.htm @@ -794,7 +794,7 @@ then have a chi distribution.. diff --git a/api/MathNet.Numerics.Distributions/ChiSquared.htm b/api/MathNet.Numerics.Distributions/ChiSquared.htm index ecb409e5..50e194bb 100644 --- a/api/MathNet.Numerics.Distributions/ChiSquared.htm +++ b/api/MathNet.Numerics.Distributions/ChiSquared.htm @@ -838,7 +838,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/ContinuousUniform.htm b/api/MathNet.Numerics.Distributions/ContinuousUniform.htm index 48135053..ace52e66 100644 --- a/api/MathNet.Numerics.Distributions/ContinuousUniform.htm +++ b/api/MathNet.Numerics.Distributions/ContinuousUniform.htm @@ -881,7 +881,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/ConwayMaxwellPoisson.htm b/api/MathNet.Numerics.Distributions/ConwayMaxwellPoisson.htm index 22dc039d..b1052151 100644 --- a/api/MathNet.Numerics.Distributions/ConwayMaxwellPoisson.htm +++ b/api/MathNet.Numerics.Distributions/ConwayMaxwellPoisson.htm @@ -793,7 +793,7 @@ distributions. It is parameterized by two real numbers "lambda" and "nu". For diff --git a/api/MathNet.Numerics.Distributions/Dirichlet.htm b/api/MathNet.Numerics.Distributions/Dirichlet.htm index 14d3f4a9..0dcf1586 100644 --- a/api/MathNet.Numerics.Distributions/Dirichlet.htm +++ b/api/MathNet.Numerics.Distributions/Dirichlet.htm @@ -572,7 +572,7 @@ You can also leave out the last x component, and it will be compute diff --git a/api/MathNet.Numerics.Distributions/DiscreteUniform.htm b/api/MathNet.Numerics.Distributions/DiscreteUniform.htm index 946c2368..e362ddc8 100644 --- a/api/MathNet.Numerics.Distributions/DiscreteUniform.htm +++ b/api/MathNet.Numerics.Distributions/DiscreteUniform.htm @@ -824,7 +824,7 @@ is parameterized by a lower and upper bound (both inclusive).. diff --git a/api/MathNet.Numerics.Distributions/Erlang.htm b/api/MathNet.Numerics.Distributions/Erlang.htm index d4eed79b..65103e5f 100644 --- a/api/MathNet.Numerics.Distributions/Erlang.htm +++ b/api/MathNet.Numerics.Distributions/Erlang.htm @@ -873,7 +873,7 @@ be initialized with the default random number generator. diff --git a/api/MathNet.Numerics.Distributions/Exponential.htm b/api/MathNet.Numerics.Distributions/Exponential.htm index be22da6d..dad4181f 100644 --- a/api/MathNet.Numerics.Distributions/Exponential.htm +++ b/api/MathNet.Numerics.Distributions/Exponential.htm @@ -838,7 +838,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/FisherSnedecor.htm b/api/MathNet.Numerics.Distributions/FisherSnedecor.htm index d29be0ec..28eaeac1 100644 --- a/api/MathNet.Numerics.Distributions/FisherSnedecor.htm +++ b/api/MathNet.Numerics.Distributions/FisherSnedecor.htm @@ -875,7 +875,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Gamma.htm b/api/MathNet.Numerics.Distributions/Gamma.htm index 8fec5158..b8604b97 100644 --- a/api/MathNet.Numerics.Distributions/Gamma.htm +++ b/api/MathNet.Numerics.Distributions/Gamma.htm @@ -928,7 +928,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Geometric.htm b/api/MathNet.Numerics.Distributions/Geometric.htm index b272b217..58761eed 100644 --- a/api/MathNet.Numerics.Distributions/Geometric.htm +++ b/api/MathNet.Numerics.Distributions/Geometric.htm @@ -765,7 +765,7 @@ This implementation of the Geometric distribution will never generate 0's.. diff --git a/api/MathNet.Numerics.Distributions/Hypergeometric.htm b/api/MathNet.Numerics.Distributions/Hypergeometric.htm index 1e224d9d..40681015 100644 --- a/api/MathNet.Numerics.Distributions/Hypergeometric.htm +++ b/api/MathNet.Numerics.Distributions/Hypergeometric.htm @@ -826,7 +826,7 @@ describes the number of successes for draws with replacement. diff --git a/api/MathNet.Numerics.Distributions/IContinuousDistribution.htm b/api/MathNet.Numerics.Distributions/IContinuousDistribution.htm index f075ef9a..4d4f92ff 100644 --- a/api/MathNet.Numerics.Distributions/IContinuousDistribution.htm +++ b/api/MathNet.Numerics.Distributions/IContinuousDistribution.htm @@ -404,7 +404,7 @@ diff --git a/api/MathNet.Numerics.Distributions/IDiscreteDistribution.htm b/api/MathNet.Numerics.Distributions/IDiscreteDistribution.htm index 46931c63..90399c4c 100644 --- a/api/MathNet.Numerics.Distributions/IDiscreteDistribution.htm +++ b/api/MathNet.Numerics.Distributions/IDiscreteDistribution.htm @@ -404,7 +404,7 @@ diff --git a/api/MathNet.Numerics.Distributions/IDistribution.htm b/api/MathNet.Numerics.Distributions/IDistribution.htm index 0e2fc793..f0620c30 100644 --- a/api/MathNet.Numerics.Distributions/IDistribution.htm +++ b/api/MathNet.Numerics.Distributions/IDistribution.htm @@ -302,7 +302,7 @@ diff --git a/api/MathNet.Numerics.Distributions/IUnivariateDistribution.htm b/api/MathNet.Numerics.Distributions/IUnivariateDistribution.htm index 302dc852..26f3f8b7 100644 --- a/api/MathNet.Numerics.Distributions/IUnivariateDistribution.htm +++ b/api/MathNet.Numerics.Distributions/IUnivariateDistribution.htm @@ -364,7 +364,7 @@ diff --git a/api/MathNet.Numerics.Distributions/InverseGamma.htm b/api/MathNet.Numerics.Distributions/InverseGamma.htm index 67427dfa..f007a704 100644 --- a/api/MathNet.Numerics.Distributions/InverseGamma.htm +++ b/api/MathNet.Numerics.Distributions/InverseGamma.htm @@ -826,7 +826,7 @@ two positive parameters.. diff --git a/api/MathNet.Numerics.Distributions/InverseGaussian.htm b/api/MathNet.Numerics.Distributions/InverseGaussian.htm index 6b5154a2..e5896a01 100644 --- a/api/MathNet.Numerics.Distributions/InverseGaussian.htm +++ b/api/MathNet.Numerics.Distributions/InverseGaussian.htm @@ -809,7 +809,7 @@ No closed form analytical expression exists, so this value is approximated numer diff --git a/api/MathNet.Numerics.Distributions/InverseWishart.htm b/api/MathNet.Numerics.Distributions/InverseWishart.htm index 406f7106..d3344f5e 100644 --- a/api/MathNet.Numerics.Distributions/InverseWishart.htm +++ b/api/MathNet.Numerics.Distributions/InverseWishart.htm @@ -529,7 +529,7 @@ a Wishart random variable and inverting the matrix. diff --git a/api/MathNet.Numerics.Distributions/Laplace.htm b/api/MathNet.Numerics.Distributions/Laplace.htm index c878c04b..9193e1cd 100644 --- a/api/MathNet.Numerics.Distributions/Laplace.htm +++ b/api/MathNet.Numerics.Distributions/Laplace.htm @@ -835,7 +835,7 @@ p(x) = \frac{1}{2 * scale} \exp{- |x - mean| / scale}.. diff --git a/api/MathNet.Numerics.Distributions/LogNormal.htm b/api/MathNet.Numerics.Distributions/LogNormal.htm index 47c4aaea..9735151a 100644 --- a/api/MathNet.Numerics.Distributions/LogNormal.htm +++ b/api/MathNet.Numerics.Distributions/LogNormal.htm @@ -954,7 +954,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/MatrixNormal.htm b/api/MathNet.Numerics.Distributions/MatrixNormal.htm index 78ab470c..6d65632b 100644 --- a/api/MathNet.Numerics.Distributions/MatrixNormal.htm +++ b/api/MathNet.Numerics.Distributions/MatrixNormal.htm @@ -517,7 +517,7 @@ for the columns (K). If the dimension of M is d-by-m then V is d-by-d and K is m diff --git a/api/MathNet.Numerics.Distributions/MeanPrecisionPair.htm b/api/MathNet.Numerics.Distributions/MeanPrecisionPair.htm index 08866f2e..7bafca69 100644 --- a/api/MathNet.Numerics.Distributions/MeanPrecisionPair.htm +++ b/api/MathNet.Numerics.Distributions/MeanPrecisionPair.htm @@ -379,7 +379,7 @@ is defined. diff --git a/api/MathNet.Numerics.Distributions/Multinomial.htm b/api/MathNet.Numerics.Distributions/Multinomial.htm index c971d461..6f080bbe 100644 --- a/api/MathNet.Numerics.Distributions/Multinomial.htm +++ b/api/MathNet.Numerics.Distributions/Multinomial.htm @@ -610,7 +610,7 @@ as this is often impossible using floating point arithmetic.

diff --git a/api/MathNet.Numerics.Distributions/NegativeBinomial.htm b/api/MathNet.Numerics.Distributions/NegativeBinomial.htm index e866116d..bfb87443 100644 --- a/api/MathNet.Numerics.Distributions/NegativeBinomial.htm +++ b/api/MathNet.Numerics.Distributions/NegativeBinomial.htm @@ -795,7 +795,7 @@ when the probability of success is p.. diff --git a/api/MathNet.Numerics.Distributions/Normal.htm b/api/MathNet.Numerics.Distributions/Normal.htm index 21f996dc..abf44d40 100644 --- a/api/MathNet.Numerics.Distributions/Normal.htm +++ b/api/MathNet.Numerics.Distributions/Normal.htm @@ -1002,7 +1002,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/NormalGamma.htm b/api/MathNet.Numerics.Distributions/NormalGamma.htm index 065949f0..fbeb1bac 100644 --- a/api/MathNet.Numerics.Distributions/NormalGamma.htm +++ b/api/MathNet.Numerics.Distributions/NormalGamma.htm @@ -687,7 +687,7 @@ will be positive infinity. A completely degenerate NormalGamma distribution with diff --git a/api/MathNet.Numerics.Distributions/Pareto.htm b/api/MathNet.Numerics.Distributions/Pareto.htm index edd901c8..60844e8a 100644 --- a/api/MathNet.Numerics.Distributions/Pareto.htm +++ b/api/MathNet.Numerics.Distributions/Pareto.htm @@ -873,7 +873,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Poisson.htm b/api/MathNet.Numerics.Distributions/Poisson.htm index c71ffd17..351d673f 100644 --- a/api/MathNet.Numerics.Distributions/Poisson.htm +++ b/api/MathNet.Numerics.Distributions/Poisson.htm @@ -797,7 +797,7 @@ diff --git a/api/MathNet.Numerics.Distributions/Rayleigh.htm b/api/MathNet.Numerics.Distributions/Rayleigh.htm index 895c7867..c7a9789a 100644 --- a/api/MathNet.Numerics.Distributions/Rayleigh.htm +++ b/api/MathNet.Numerics.Distributions/Rayleigh.htm @@ -841,7 +841,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/SkewedGeneralizedError.htm b/api/MathNet.Numerics.Distributions/SkewedGeneralizedError.htm index b8a462dd..4b118592 100644 --- a/api/MathNet.Numerics.Distributions/SkewedGeneralizedError.htm +++ b/api/MathNet.Numerics.Distributions/SkewedGeneralizedError.htm @@ -803,7 +803,7 @@ with location=0.0, scale=1.0, skew=0.0 and p=2.0 (a standard normal distribution diff --git a/api/MathNet.Numerics.Distributions/SkewedGeneralizedT.htm b/api/MathNet.Numerics.Distributions/SkewedGeneralizedT.htm index 8bb90c1a..18cff87f 100644 --- a/api/MathNet.Numerics.Distributions/SkewedGeneralizedT.htm +++ b/api/MathNet.Numerics.Distributions/SkewedGeneralizedT.htm @@ -952,7 +952,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Stable.htm b/api/MathNet.Numerics.Distributions/Stable.htm index 00592a12..edf468da 100644 --- a/api/MathNet.Numerics.Distributions/Stable.htm +++ b/api/MathNet.Numerics.Distributions/Stable.htm @@ -898,7 +898,7 @@ For details about this distribution, see. diff --git a/api/MathNet.Numerics.Distributions/StudentT.htm b/api/MathNet.Numerics.Distributions/StudentT.htm index abe6a1f3..323b712a 100644 --- a/api/MathNet.Numerics.Distributions/StudentT.htm +++ b/api/MathNet.Numerics.Distributions/StudentT.htm @@ -933,7 +933,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/Triangular.htm b/api/MathNet.Numerics.Distributions/Triangular.htm index 84a2adf7..42a2d407 100644 --- a/api/MathNet.Numerics.Distributions/Triangular.htm +++ b/api/MathNet.Numerics.Distributions/Triangular.htm @@ -901,7 +901,7 @@ at the given probability. This is also known as the quantile or percent point fu diff --git a/api/MathNet.Numerics.Distributions/TruncatedPareto.htm b/api/MathNet.Numerics.Distributions/TruncatedPareto.htm index 86d36fd3..807f5ce2 100644 --- a/api/MathNet.Numerics.Distributions/TruncatedPareto.htm +++ b/api/MathNet.Numerics.Distributions/TruncatedPareto.htm @@ -824,7 +824,7 @@ diff --git a/api/MathNet.Numerics.Distributions/Weibull.htm b/api/MathNet.Numerics.Distributions/Weibull.htm index d0488a39..16508dac 100644 --- a/api/MathNet.Numerics.Distributions/Weibull.htm +++ b/api/MathNet.Numerics.Distributions/Weibull.htm @@ -840,7 +840,7 @@ For details about this distribution, see.
diff --git a/api/MathNet.Numerics.Distributions/Wishart.htm b/api/MathNet.Numerics.Distributions/Wishart.htm index 152e2b2f..7f172bc5 100644 --- a/api/MathNet.Numerics.Distributions/Wishart.htm +++ b/api/MathNet.Numerics.Distributions/Wishart.htm @@ -530,7 +530,7 @@ Applied Statistics, Vol. 21, No. 3 (1972), pp. 341-345 diff --git a/api/MathNet.Numerics.Distributions/Zipf.htm b/api/MathNet.Numerics.Distributions/Zipf.htm index d1805f54..7483e3e2 100644 --- a/api/MathNet.Numerics.Distributions/Zipf.htm +++ b/api/MathNet.Numerics.Distributions/Zipf.htm @@ -796,7 +796,7 @@ For details about this distribution, see. diff --git a/api/MathNet.Numerics.Distributions/index.htm b/api/MathNet.Numerics.Distributions/index.htm index e77b0a3f..a29958fc 100644 --- a/api/MathNet.Numerics.Distributions/index.htm +++ b/api/MathNet.Numerics.Distributions/index.htm @@ -330,7 +330,7 @@ diff --git a/api/MathNet.Numerics.Financial/AbsoluteReturnMeasures.htm b/api/MathNet.Numerics.Financial/AbsoluteReturnMeasures.htm index 6516b9e1..27e30290 100644 --- a/api/MathNet.Numerics.Financial/AbsoluteReturnMeasures.htm +++ b/api/MathNet.Numerics.Financial/AbsoluteReturnMeasures.htm @@ -196,7 +196,7 @@ and then dividing the total by the number of loss periods.
-

Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

+

Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

Generated by docu

diff --git a/api/MathNet.Numerics.Financial/AbsoluteRiskMeasures.htm b/api/MathNet.Numerics.Financial/AbsoluteRiskMeasures.htm index b974e842..15b187ef 100644 --- a/api/MathNet.Numerics.Financial/AbsoluteRiskMeasures.htm +++ b/api/MathNet.Numerics.Financial/AbsoluteRiskMeasures.htm @@ -219,7 +219,7 @@ looks at periods where the investment return was less than average return. diff --git a/api/MathNet.Numerics.Financial/index.htm b/api/MathNet.Numerics.Financial/index.htm index bc29152b..43d0afcc 100644 --- a/api/MathNet.Numerics.Financial/index.htm +++ b/api/MathNet.Numerics.Financial/index.htm @@ -147,7 +147,7 @@ diff --git a/api/MathNet.Numerics.IntegralTransforms/Fourier.htm b/api/MathNet.Numerics.IntegralTransforms/Fourier.htm index 259a7ddc..6bec8ac4 100644 --- a/api/MathNet.Numerics.IntegralTransforms/Fourier.htm +++ b/api/MathNet.Numerics.IntegralTransforms/Fourier.htm @@ -984,7 +984,7 @@ The data array needs to be N+2 (if N is even) or N+1 (if N is odd) long in order diff --git a/api/MathNet.Numerics.IntegralTransforms/FourierOptions.htm b/api/MathNet.Numerics.IntegralTransforms/FourierOptions.htm index 0f048777..29c0519f 100644 --- a/api/MathNet.Numerics.IntegralTransforms/FourierOptions.htm +++ b/api/MathNet.Numerics.IntegralTransforms/FourierOptions.htm @@ -369,7 +369,7 @@ diff --git a/api/MathNet.Numerics.IntegralTransforms/Hartley.htm b/api/MathNet.Numerics.IntegralTransforms/Hartley.htm index 859ec4de..33786168 100644 --- a/api/MathNet.Numerics.IntegralTransforms/Hartley.htm +++ b/api/MathNet.Numerics.IntegralTransforms/Hartley.htm @@ -212,7 +212,7 @@ diff --git a/api/MathNet.Numerics.IntegralTransforms/HartleyOptions.htm b/api/MathNet.Numerics.IntegralTransforms/HartleyOptions.htm index 5e62619d..fce0e8ae 100644 --- a/api/MathNet.Numerics.IntegralTransforms/HartleyOptions.htm +++ b/api/MathNet.Numerics.IntegralTransforms/HartleyOptions.htm @@ -330,7 +330,7 @@ diff --git a/api/MathNet.Numerics.IntegralTransforms/index.htm b/api/MathNet.Numerics.IntegralTransforms/index.htm index f8dd9e71..81b7bd8a 100644 --- a/api/MathNet.Numerics.IntegralTransforms/index.htm +++ b/api/MathNet.Numerics.IntegralTransforms/index.htm @@ -155,7 +155,7 @@ diff --git a/api/MathNet.Numerics.Integration/DoubleExponentialTransformation.htm b/api/MathNet.Numerics.Integration/DoubleExponentialTransformation.htm index 5627756f..587b5d22 100644 --- a/api/MathNet.Numerics.Integration/DoubleExponentialTransformation.htm +++ b/api/MathNet.Numerics.Integration/DoubleExponentialTransformation.htm @@ -224,7 +224,7 @@ or derivative discontinuities and no poles inside the interval. diff --git a/api/MathNet.Numerics.Integration/GaussKronrodRule.htm b/api/MathNet.Numerics.Integration/GaussKronrodRule.htm index 2834e5b3..e560b242 100644 --- a/api/MathNet.Numerics.Integration/GaussKronrodRule.htm +++ b/api/MathNet.Numerics.Integration/GaussKronrodRule.htm @@ -280,7 +280,7 @@ diff --git a/api/MathNet.Numerics.Integration/GaussLegendreRule.htm b/api/MathNet.Numerics.Integration/GaussLegendreRule.htm index 3216a6c0..b1e780ad 100644 --- a/api/MathNet.Numerics.Integration/GaussLegendreRule.htm +++ b/api/MathNet.Numerics.Integration/GaussLegendreRule.htm @@ -406,7 +406,7 @@ diff --git a/api/MathNet.Numerics.Integration/NewtonCotesTrapeziumRule.htm b/api/MathNet.Numerics.Integration/NewtonCotesTrapeziumRule.htm index 23b9d216..f8decf0e 100644 --- a/api/MathNet.Numerics.Integration/NewtonCotesTrapeziumRule.htm +++ b/api/MathNet.Numerics.Integration/NewtonCotesTrapeziumRule.htm @@ -393,7 +393,7 @@ diff --git a/api/MathNet.Numerics.Integration/SimpsonRule.htm b/api/MathNet.Numerics.Integration/SimpsonRule.htm index 73d88a30..c7aa75aa 100644 --- a/api/MathNet.Numerics.Integration/SimpsonRule.htm +++ b/api/MathNet.Numerics.Integration/SimpsonRule.htm @@ -221,7 +221,7 @@ diff --git a/api/MathNet.Numerics.Integration/index.htm b/api/MathNet.Numerics.Integration/index.htm index 1fa99ff0..0bad8f84 100644 --- a/api/MathNet.Numerics.Integration/index.htm +++ b/api/MathNet.Numerics.Integration/index.htm @@ -159,7 +159,7 @@ diff --git a/api/MathNet.Numerics.Interpolation/Barycentric.htm b/api/MathNet.Numerics.Interpolation/Barycentric.htm index 7f4dd31c..bc027047 100644 --- a/api/MathNet.Numerics.Interpolation/Barycentric.htm +++ b/api/MathNet.Numerics.Interpolation/Barycentric.htm @@ -443,7 +443,7 @@ The values are assumed to be sorted ascendingly by x. diff --git a/api/MathNet.Numerics.Interpolation/BulirschStoerRationalInterpolation.htm b/api/MathNet.Numerics.Interpolation/BulirschStoerRationalInterpolation.htm index 70a1d3f3..1d70fa4a 100644 --- a/api/MathNet.Numerics.Interpolation/BulirschStoerRationalInterpolation.htm +++ b/api/MathNet.Numerics.Interpolation/BulirschStoerRationalInterpolation.htm @@ -310,7 +310,7 @@ WARNING: Works in-place and can thus causes the data array to be reordered. diff --git a/api/MathNet.Numerics.Interpolation/CubicSpline.htm b/api/MathNet.Numerics.Interpolation/CubicSpline.htm index 15461071..f0815cbe 100644 --- a/api/MathNet.Numerics.Interpolation/CubicSpline.htm +++ b/api/MathNet.Numerics.Interpolation/CubicSpline.htm @@ -193,6 +193,9 @@
  • InterpolateNatural
  • InterpolateNaturalInplace
  • InterpolateNaturalSorted
    • +
  • InterpolatePchip
    • +
  • InterpolatePchipInplace
    • +
  • InterpolatePchipSorted

    • Methods

      @@ -357,6 +360,37 @@ and zero second derivatives at the two boundaries, sorted ascendingly by x. + + +
      +

      CubicSpline InterpolatePchip(IEnumerable<double> x, IEnumerable<double> y)

      +
      Create a piecewise cubic Hermite interpolating polynomial from an unsorted set of (x,y) value pairs. +Monotone-preserving interpolation with continuous first derivative. + + + + +
      +
      +
      +

      CubicSpline InterpolatePchipInplace(Double[] x, Double[] y)

      +
      Create a piecewise cubic Hermite interpolating polynomial from an unsorted set of (x,y) value pairs. +Monotone-preserving interpolation with continuous first derivative. +WARNING: Works in-place and can thus causes the data array to be reordered. + + + + +
      +
      +
      +

      CubicSpline InterpolatePchipSorted(Double[] x, Double[] y)

      +
      Create a piecewise cubic Hermite interpolating polynomial from an unsorted set of (x,y) value pairs. +Monotone-preserving interpolation with continuous first derivative. + + + +
      @@ -430,32 +464,32 @@ and zero second derivatives at the two boundaries, sorted ascendingly by x.
      -

      double Integrate(double t)

      -
      Indefinite integral at point t. +

      double Integrate(double a, double b)

      +
      Definite integral between points a and b.
      Parameters
      -
      double t
      -

      Point t to integrate at.

      +
      double a
      +

      Left bound of the integration interval [a,b].

      +
      double b
      +

      Right bound of the integration interval [a,b].

      -

      double Integrate(double a, double b)

      -
      Definite integral between points a and b. +

      double Integrate(double t)

      +
      Indefinite integral at point t.
      Parameters
      -
      double a
      -

      Left bound of the integration interval [a,b].

      -
      double b
      -

      Right bound of the integration interval [a,b].

      +
      double t
      +

      Point t to integrate at.

      @@ -492,7 +526,7 @@ and zero second derivatives at the two boundaries, sorted ascendingly by x.
      diff --git a/api/MathNet.Numerics.Interpolation/IInterpolation.htm b/api/MathNet.Numerics.Interpolation/IInterpolation.htm index 2b015b22..78a59a5a 100644 --- a/api/MathNet.Numerics.Interpolation/IInterpolation.htm +++ b/api/MathNet.Numerics.Interpolation/IInterpolation.htm @@ -303,7 +303,7 @@
      diff --git a/api/MathNet.Numerics.Interpolation/LinearSpline.htm b/api/MathNet.Numerics.Interpolation/LinearSpline.htm index ff5c3656..e977832b 100644 --- a/api/MathNet.Numerics.Interpolation/LinearSpline.htm +++ b/api/MathNet.Numerics.Interpolation/LinearSpline.htm @@ -388,7 +388,7 @@ WARNING: Works in-place and can thus causes the data array to be reordered.
      diff --git a/api/MathNet.Numerics.Interpolation/LogLinear.htm b/api/MathNet.Numerics.Interpolation/LogLinear.htm index f207819a..a2ee1b48 100644 --- a/api/MathNet.Numerics.Interpolation/LogLinear.htm +++ b/api/MathNet.Numerics.Interpolation/LogLinear.htm @@ -352,7 +352,7 @@ WARNING: Works in-place and can thus causes the data array to be reordered and m diff --git a/api/MathNet.Numerics.Interpolation/NevillePolynomialInterpolation.htm b/api/MathNet.Numerics.Interpolation/NevillePolynomialInterpolation.htm index 5c0b5acd..dfd80991 100644 --- a/api/MathNet.Numerics.Interpolation/NevillePolynomialInterpolation.htm +++ b/api/MathNet.Numerics.Interpolation/NevillePolynomialInterpolation.htm @@ -354,7 +354,7 @@ WARNING: Works in-place and can thus causes the data array to be reordered. diff --git a/api/MathNet.Numerics.Interpolation/QuadraticSpline.htm b/api/MathNet.Numerics.Interpolation/QuadraticSpline.htm index fc4042db..f14ded35 100644 --- a/api/MathNet.Numerics.Interpolation/QuadraticSpline.htm +++ b/api/MathNet.Numerics.Interpolation/QuadraticSpline.htm @@ -354,7 +354,7 @@ diff --git a/api/MathNet.Numerics.Interpolation/SplineBoundaryCondition.htm b/api/MathNet.Numerics.Interpolation/SplineBoundaryCondition.htm index bfaa5b8e..a7fef879 100644 --- a/api/MathNet.Numerics.Interpolation/SplineBoundaryCondition.htm +++ b/api/MathNet.Numerics.Interpolation/SplineBoundaryCondition.htm @@ -364,7 +364,7 @@ diff --git a/api/MathNet.Numerics.Interpolation/StepInterpolation.htm b/api/MathNet.Numerics.Interpolation/StepInterpolation.htm index a96e2e0e..31c4e0c5 100644 --- a/api/MathNet.Numerics.Interpolation/StepInterpolation.htm +++ b/api/MathNet.Numerics.Interpolation/StepInterpolation.htm @@ -388,7 +388,7 @@ WARNING: Works in-place and can thus causes the data array to be reordered. diff --git a/api/MathNet.Numerics.Interpolation/TransformedInterpolation.htm b/api/MathNet.Numerics.Interpolation/TransformedInterpolation.htm index 6d2d0742..ea234243 100644 --- a/api/MathNet.Numerics.Interpolation/TransformedInterpolation.htm +++ b/api/MathNet.Numerics.Interpolation/TransformedInterpolation.htm @@ -302,7 +302,7 @@ WARNING: Works in-place and can thus causes the data array to be reordered and m diff --git a/api/MathNet.Numerics.Interpolation/index.htm b/api/MathNet.Numerics.Interpolation/index.htm index 399e07d5..cbe370be 100644 --- a/api/MathNet.Numerics.Interpolation/index.htm +++ b/api/MathNet.Numerics.Interpolation/index.htm @@ -186,7 +186,7 @@
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/BiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/BiCgStab.htm index b78bc3b9..2c276d17 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/BiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/BiCgStab.htm @@ -271,7 +271,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/CompositeSolver.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/CompositeSolver.htm index 59cf00c0..9fa63841 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/CompositeSolver.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/CompositeSolver.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/DiagonalPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/DiagonalPreconditioner.htm index 711ae7fa..29927542 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/DiagonalPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/DiagonalPreconditioner.htm @@ -272,7 +272,7 @@ of the matrix diagonal as preconditioning values. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm index f8c6b549..d629b8ae 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm @@ -291,7 +291,7 @@ before switching over to the BiCgStab algorithm. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILU0Preconditioner.htm index 60e4d71b..e8a59e40 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILU0Preconditioner.htm @@ -273,7 +273,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILUTPPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILUTPPreconditioner.htm index 67cf420e..6aa89ab2 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILUTPPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILUTPPreconditioner.htm @@ -384,7 +384,7 @@ the preconditioner.

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MILU0Preconditioner.htm index 947f5564..774a6eee 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MILU0Preconditioner.htm @@ -298,7 +298,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MlkBiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MlkBiCgStab.htm index dcc4d0b1..72d6a353 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MlkBiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/MlkBiCgStab.htm @@ -299,7 +299,7 @@ Krylov sub-space. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/TFQMR.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/TFQMR.htm index 6d6ea419..33802e61 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/TFQMR.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/TFQMR.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm index b73b22f6..cc3ab1b1 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm @@ -175,7 +175,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/DenseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/DenseMatrix.htm index 1d5c23d0..578a3533 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/DenseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/DenseMatrix.htm @@ -402,6 +402,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -507,8 +508,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    DenseMatrix(int rows, int columns)

    Create a new dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -518,8 +518,7 @@ Zero-length matrices are not supported.

    DenseMatrix(int order)

    Create a new square dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -542,8 +541,8 @@ storage for performance or interop reasons.

    Public Static Functions

    -

    DenseMatrix Create(int rows, int columns, Complex value)

    -
    Create a new dense matrix and initialize each value to the same provided value. +

    DenseMatrix Create(int rows, int columns, Func<int, int, Complex> init)

    +
    Create a new dense matrix and initialize each value using the provided init function. @@ -551,8 +550,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix Create(int rows, int columns, Func<int, int, Complex> init)

    -
    Create a new dense matrix and initialize each value using the provided init function. +

    DenseMatrix Create(int rows, int columns, Complex value)

    +
    Create a new dense matrix and initialize each value to the same provided value. @@ -560,8 +559,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix CreateDiagonal(int rows, int columns, Complex value)

    -
    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. +

    DenseMatrix CreateDiagonal(int rows, int columns, Func<int, Complex> init)

    +
    Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. @@ -569,8 +568,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix CreateDiagonal(int rows, int columns, Func<int, Complex> init)

    -
    Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. +

    DenseMatrix CreateDiagonal(int rows, int columns, Complex value)

    +
    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. @@ -605,8 +604,10 @@ storage for performance or interop reasons.
    -

    DenseMatrix OfColumnArrays(Complex[][] columns)

    -
    +

    DenseMatrix OfColumnArrays(IEnumerable<Complex[]> columns)

    +
    Create a new dense matrix as a copy of the given column arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -614,10 +615,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix OfColumnArrays(IEnumerable<Complex[]> columns)

    -
    Create a new dense matrix as a copy of the given column arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    DenseMatrix OfColumnArrays(Complex[][] columns)

    +
    @@ -637,7 +636,7 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumns(int rows, int columns, IEnumerable<IEnumerable<Complex>> data)

    +

    DenseMatrix OfColumns(IEnumerable<IEnumerable<Complex>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable columns. Each enumerable in the master enumerable specifies a column. This new matrix will be independent from the enumerables. @@ -649,7 +648,7 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumns(IEnumerable<IEnumerable<Complex>> data)

    +

    DenseMatrix OfColumns(int rows, int columns, IEnumerable<IEnumerable<Complex>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable columns. Each enumerable in the master enumerable specifies a column. This new matrix will be independent from the enumerables. @@ -815,7 +814,7 @@ A new memory block will be allocated for storing the matrix.

    Public Methods

    -

    Matrix<T> Add(Complex scalar)

    +

    void Add(Complex scalar, Matrix<T> result)

    @@ -824,10 +823,18 @@ A new memory block will be allocated for storing the matrix.
    -

    void Add(Complex scalar, Matrix<T> result)

    -
    +

    void Add(Matrix<T> other, Matrix<T> result)

    +
    Adds another matrix to this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    +
    @@ -853,18 +860,10 @@ A new memory block will be allocated for storing the matrix.
    -

    void Add(Matrix<T> other, Matrix<T> result)

    -
    Adds another matrix to this matrix. - +

    Matrix<T> Add(Complex scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    -
    @@ -969,15 +968,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    -
    -
    -

    void At(int row, int column, Complex value)

    -
    - - - -
    @@ -1000,6 +990,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    +
    +
    +
    +

    void At(int row, int column, Complex value)

    +
    + + + +
    @@ -1077,15 +1076,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    A clone of the instance.

    -
    -
    -
    -

    void CoerceZero(Func<Complex, bool> zeroPredicate)

    -
    Set all values that meet the predicate to zero, in-place. - - - -
    @@ -1097,23 +1087,12 @@ Use ToRowMajorArray instead if you always need an independent array.
    -
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. - +
    +

    void CoerceZero(Func<Complex, bool> zeroPredicate)

    +
    Set all values that meet the predicate to zero, in-place. -
    -
    Parameters
    -
    int index
    -

    The column to copy.

    -
    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    @@ -1177,6 +1156,26 @@ Use ToRowMajorArray instead if you always need an independent array.
    +
    +
    +
    +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>. + + +
    +
    Parameters
    + +
    int index
    +

    The column to copy.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    +
    @@ -1221,20 +1220,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The condition number of the matrix.

    -
    -
    -
    -

    Matrix<T> Conjugate()

    -
    Complex conjugate each element of this matrix. - - - -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the conjugated values.

    -
    -
    @@ -1252,16 +1237,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    Matrix<T> ConjugateTranspose()

    -
    Returns the conjugate transpose of this matrix. +
    +

    Matrix<T> Conjugate()

    +
    Complex conjugate each element of this matrix.
    Return
    Matrix<T>
    -

    The conjugate transpose of this matrix.

    +

    A matrix containing the conjugated values.

    @@ -1275,20 +1260,17 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. +
    +

    Matrix<T> ConjugateTranspose()

    +
    Returns the conjugate transpose of this matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The conjugate transpose of this matrix.

    -
    @@ -1312,9 +1294,9 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +
    +

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix.
    @@ -1327,6 +1309,26 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    +
    @@ -1367,8 +1369,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -1376,13 +1378,10 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -1472,7 +1471,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    Matrix<T> Divide(Complex scalar)

    +

    void Divide(Complex scalar, Matrix<T> result)

    @@ -1481,7 +1480,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    void Divide(Complex scalar, Matrix<T> result)

    +

    Matrix<T> Divide(Complex scalar)

    @@ -1490,7 +1489,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    Matrix<T> DivideByThis(Complex scalar)

    +

    void DivideByThis(Complex scalar, Matrix<T> result)

    @@ -1499,7 +1498,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    void DivideByThis(Complex scalar, Matrix<T> result)

    +

    Matrix<T> DivideByThis(Complex scalar)

    @@ -1508,7 +1507,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    IEnumerable<Complex> Enumerate()

    +

    IEnumerable<Complex> Enumerate(Zeros zeros)

    Returns an IEnumerable that can be used to iterate through all values of the matrix.
    The enumerator will include all values, even if they are zero. The ordering of the values is unspecified (not necessarily column-wise or row-wise). @@ -1520,7 +1519,7 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    -

    IEnumerable<Complex> Enumerate(Zeros zeros)

    +

    IEnumerable<Complex> Enumerate()

    Returns an IEnumerable that can be used to iterate through all values of the matrix.
    The enumerator will include all values, even if they are zero. The ordering of the values is unspecified (not necessarily column-wise or row-wise). @@ -1529,15 +1528,6 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi -
    -
    -
    -

    IEnumerable<Vector<Complex>> EnumerateColumns()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - -
    @@ -1555,6 +1545,15 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    +
    +
    +
    +

    IEnumerable<Vector<Complex>> EnumerateColumns()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. + + + +
    @@ -1613,6 +1612,15 @@ The enumerator will include all values, even if they are zero. +
    +
    +
    +

    IEnumerable<Vector<Complex>> EnumerateRows()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix. + + + +
    @@ -1632,9 +1640,12 @@ The enumerator will include all values, even if they are zero.
    -
    -

    IEnumerable<Vector<Complex>> EnumerateRows()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix. +
    +

    IEnumerable<Tuple<int, Vector<Complex>>> EnumerateRowsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the row index +and the second value being the value of the row at that index. +
    @@ -1659,56 +1670,44 @@ and the second value being the value of the row at that index.
    -
    -
    -
    -

    IEnumerable<Tuple<int, Vector<Complex>>> EnumerateRowsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the row index -and the second value being the value of the row at that index. -
    - - - -
    -

    bool Equals(Matrix<T> other)

    -
    Indicates whether the current object is equal to another object of the same type. +

    bool Equals(object obj)

    +
    Determines whether the specified Object is equal to this instance.
    Parameters
    -
    Matrix<T> other
    -

    An object to compare with this object.

    +
    object obj
    +

    The Object to compare with this instance.

    Return
    bool
    -

    true if the current object is equal to the other parameter; otherwise, false.

    +

    true if the specified Object is equal to this instance; otherwise, false.

    -

    bool Equals(object obj)

    -
    Determines whether the specified Object is equal to this instance. +

    bool Equals(Matrix<T> other)

    +
    Indicates whether the current object is equal to another object of the same type.
    Parameters
    -
    object obj
    -

    The Object to compare with this instance.

    +
    Matrix<T> other
    +

    An object to compare with this object.

    Return
    bool
    -

    true if the specified Object is equal to this instance; otherwise, false.

    +

    true if the current object is equal to the other parameter; otherwise, false.

    @@ -1978,7 +1977,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1988,18 +1987,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -2009,10 +2005,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -2048,8 +2047,8 @@ In a later release, it will be replaced with a sparse implementation.
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -2057,16 +2056,19 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -2074,13 +2076,10 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    - -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    +
    @@ -2251,7 +2250,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void ModulusByThis(Complex dividend, Matrix<T> result)

    +

    Matrix<T> ModulusByThis(Complex dividend)

    @@ -2260,7 +2259,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> ModulusByThis(Complex dividend)

    +

    void ModulusByThis(Complex dividend, Matrix<T> result)

    @@ -2323,6 +2322,23 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    + +
    +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -2343,18 +2359,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. +
    +

    void Negate(Matrix<T> result)

    +
    Negate each element of this matrix and place the results into the result matrix.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    Matrix<T> result
    -

    The result of the multiplication.

    +

    The result of the negation.

    @@ -2372,21 +2386,6 @@ on the actual data storage implementation (relevant mostly for sparse matrices).

    A matrix containing the negated values.

    -
    -
    -
    -

    void Negate(Matrix<T> result)

    -
    Negate each element of this matrix and place the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The result of the negation.

    -
    - -
    @@ -2454,25 +2453,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbs(Matrix<T> result)

    +

    Matrix<T> PointwiseAbs()

    Pointwise applies the abs function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAbs()

    +

    void PointwiseAbs(Matrix<T> result)

    Pointwise applies the abs function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2528,18 +2527,19 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the absolute minimum with the values of another matrix to each value. +

    Matrix<T> PointwiseAbsoluteMinimum(Complex scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(Complex scalar, Matrix<T> result)

    +
    + +
    @@ -2560,19 +2560,18 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Complex scalar, Matrix<T> result)

    -
    - - +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +
    Pointwise applies the absolute minimum with the values of another matrix to each value. - -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMinimum(Complex scalar)

    -
    +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    @@ -2602,25 +2601,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAsin(Matrix<T> result)

    +

    Matrix<T> PointwiseAsin()

    Pointwise applies the asin function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAsin()

    +

    void PointwiseAsin(Matrix<T> result)

    Pointwise applies the asin function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2647,17 +2646,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    - - -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    -
    Pointwise applies the atan2 function to each value of the current -matrix and a given other matrix being the 'x' of atan2 and the -'this' matrix being the 'y' - - - -
    @@ -2679,9 +2667,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCeiling()

    -
    Pointwise applies the ceiling function to each value +
    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +
    Pointwise applies the atan2 function to each value of the current +matrix and a given other matrix being the 'x' of atan2 and the +'this' matrix being the 'y' @@ -2703,9 +2693,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCos()

    -
    Pointwise applies the cos function to each value +
    +

    Matrix<T> PointwiseCeiling()

    +
    Pointwise applies the ceiling function to each value @@ -2725,6 +2715,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    Matrix<T> PointwiseCos()

    +
    Pointwise applies the cos function to each value + + + +
    @@ -2861,31 +2860,31 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2894,13 +2893,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2909,8 +2910,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2935,18 +2934,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(Complex scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2961,16 +2952,22 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(Complex scalar)

    -
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2979,6 +2976,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -3056,24 +3055,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. - +

    Matrix<T> PointwisePower(Complex exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    -

    Matrix<T> PointwisePower(Complex exponent)

    +

    void PointwisePower(Complex exponent, Matrix<T> result)

    @@ -3082,10 +3073,18 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(Complex exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. +
    +
    Parameters
    + +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -3236,25 +3235,25 @@ of this matrix by another matrix.
    -

    Matrix<T> PointwiseSqrt()

    +

    void PointwiseSqrt(Matrix<T> result)

    Pointwise applies the sqrt function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseSqrt(Matrix<T> result)

    +

    Matrix<T> PointwiseSqrt()

    Pointwise applies the sqrt function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -3284,32 +3283,32 @@ of this matrix by another matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3317,16 +3316,14 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3334,6 +3331,8 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    @@ -3473,6 +3472,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3661,8 +3683,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3670,10 +3692,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3682,8 +3700,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3691,6 +3709,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3851,20 +3873,28 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    +
    +
    Parameters
    +
    Vector<T> input
    +

    The solution vector b.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Vector<T>
    +

    The result vector x.

    +
    @@ -3895,28 +3925,20 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Vector<T> input
    -

    The solution vector b.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + -
    -
    Return
    -
    Vector<T>
    -

    The result vector x.

    -
    @@ -3930,7 +3952,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4006,32 +4028,32 @@ does not contain the diagonal elements of this matrix.
    -

    void StrictlyUpperTriangle(Matrix<T> result)

    -
    Puts the strictly upper triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyUpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> StrictlyUpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyUpperTriangle(Matrix<T> result)

    +
    Puts the strictly upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4059,6 +4081,23 @@ does not contain the diagonal elements of this matrix.

    The requested sub-matrix.

    +
    +
    +
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    + +
    @@ -4097,23 +4136,6 @@ does not contain the diagonal elements of this matrix.

    The result of the subtraction.

    -
    - -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    - -
    @@ -4187,8 +4209,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4205,8 +4227,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    +
    @@ -4214,7 +4236,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4318,15 +4340,6 @@ The maximum number of cells can be configured in the -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. - - - -
    @@ -4341,6 +4354,15 @@ The maximum number of cells can be configured in the +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4378,6 +4400,23 @@ The maximum number of cells can be configured in the +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -4435,23 +4474,6 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -4537,31 +4559,31 @@ The maximum number of cells can be configured in the -

    void UpperTriangle(Matrix<T> result)

    -
    Puts the upper triangle of this matrix into the result matrix. +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +

    void UpperTriangle(Matrix<T> result)

    +
    Puts the upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4601,7 +4623,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/DenseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/DenseVector.htm index e5998761..00b63479 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/DenseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/DenseVector.htm @@ -374,8 +374,7 @@ Very efficient, but changes to the array and the vector will affect each other.

    DenseVector(int length)

    Create a new dense vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2637,7 +2636,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/DiagonalMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/DiagonalMatrix.htm index 7894b59f..b6909b3a 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/DiagonalMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/DiagonalMatrix.htm @@ -389,6 +389,7 @@ entries are set. The exception to this is when the off diagonal elements are
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -505,8 +506,7 @@ storage for performance or interop reasons.

    DiagonalMatrix(int order)

    Create a new square diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -516,8 +516,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns)

    Create a new diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -527,8 +526,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns, Complex diagonalValue)

    Create a new diagonal matrix with the given number of rows and columns. -All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. -Zero-length matrices are not supported. +All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. @@ -1470,41 +1468,41 @@ and the second value being the value of the row at that index.
    -

    bool Equals(object obj)

    -
    Determines whether the specified Object is equal to this instance. +

    bool Equals(Matrix<T> other)

    +
    Indicates whether the current object is equal to another object of the same type.
    Parameters
    -
    object obj
    -

    The Object to compare with this instance.

    +
    Matrix<T> other
    +

    An object to compare with this object.

    Return
    bool
    -

    true if the specified Object is equal to this instance; otherwise, false.

    +

    true if the current object is equal to the other parameter; otherwise, false.

    -

    bool Equals(Matrix<T> other)

    -
    Indicates whether the current object is equal to another object of the same type. +

    bool Equals(object obj)

    +
    Determines whether the specified Object is equal to this instance.
    Parameters
    -
    Matrix<T> other
    -

    An object to compare with this object.

    +
    object obj
    +

    The Object to compare with this instance.

    Return
    bool
    -

    true if the current object is equal to the other parameter; otherwise, false.

    +

    true if the specified Object is equal to this instance; otherwise, false.

    @@ -1774,7 +1772,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1784,15 +1782,18 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1802,13 +1803,10 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    @@ -2044,7 +2042,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void ModulusByThis(Complex dividend, Matrix<T> result)

    +

    Matrix<T> ModulusByThis(Complex dividend)

    @@ -2053,7 +2051,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> ModulusByThis(Complex dividend)

    +

    void ModulusByThis(Complex dividend, Matrix<T> result)

    @@ -2634,25 +2632,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog()

    +

    void PointwiseLog(Matrix<T> result)

    Pointwise applies the natural logarithm function to each value. +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    -

    void PointwiseLog(Matrix<T> result)

    +

    Matrix<T> PointwiseLog()

    Pointwise applies the natural logarithm function to each value. -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2679,6 +2677,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    +
    +
    +

    void PointwiseMaximum(Complex scalar, Matrix<T> result)

    +
    + + + +
    @@ -2714,7 +2721,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(Complex scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Complex scalar)

    @@ -2722,11 +2729,17 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseMaximum(Complex scalar)

    -
    +
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. + +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2741,24 +2754,16 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(Complex scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2767,18 +2772,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -
    -
    -
    -

    Matrix<T> PointwiseMinimum(Complex scalar)

    -
    - - - -
    @@ -2816,8 +2814,8 @@ of this matrix by another matrix.
    -

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    -
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    +
    Pointwise multiplies this matrix with another matrix.
    @@ -2825,16 +2823,19 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise multiplication of this matrix and other.

    +
    -

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    -
    Pointwise multiplies this matrix with another matrix. +

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    +
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix.
    @@ -2842,29 +2843,27 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise multiplication of this matrix and other.

    -
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(Complex exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    + +
    +
    +
    +

    void PointwisePower(Complex exponent, Matrix<T> result)

    +
    + +
    @@ -2885,19 +2884,18 @@ of this matrix by another matrix.
    -

    void PointwisePower(Complex exponent, Matrix<T> result)

    -
    - - +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. - -
    -
    -
    -

    Matrix<T> PointwisePower(Complex exponent)

    -
    +
    +
    Parameters
    +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -2937,25 +2935,25 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRound(Matrix<T> result)

    +

    Matrix<T> PointwiseRound()

    Pointwise applies the round function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseRound()

    +

    void PointwiseRound(Matrix<T> result)

    Pointwise applies the round function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -3081,32 +3079,32 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3114,14 +3112,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3129,8 +3129,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    @@ -3272,23 +3270,47 @@ also known as the range or image of the corresponding matrix transformation.
    -
    -

    Vector<T> Row(int index)

    -
    Copies a row into an Vector. +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero.
    Parameters
    -
    int index
    -

    The row to copy.

    +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    + +
    +
    +
    +

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    +
    Copies the requested row elements into a new Vector. + + +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy elements from.

    +
    int columnIndex
    +

    The column to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    +
    @@ -3334,24 +3356,23 @@ also known as the range or image of the corresponding matrix transformation.
    -

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    -
    Copies the requested row elements into a new Vector. +

    Vector<T> Row(int index)

    +
    Copies a row into an Vector.
    Parameters
    -
    int rowIndex
    -

    The row to copy elements from.

    -
    int columnIndex
    -

    The column to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The row to copy.

    - +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    +
    @@ -3380,15 +3401,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Complex[] column)

    -
    - - - -
    @@ -3427,11 +3439,20 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Complex[] column)

    +
    + + + +
    -

    void SetDiagonal(Complex[] source)

    -
    Copies the values of the given array to the diagonal.
    +

    void SetDiagonal(Vector<T> source)

    +
    Copies the values of the given Vector<T> to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3440,8 +3461,8 @@ this[i,i].
    Parameters
    -
    Complex[] source
    -

    The array to copy the values from. The length of the vector should be +

    Vector<T> source
    +

    The vector to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3449,8 +3470,8 @@ Min(Rows, Columns).

    -

    void SetDiagonal(Vector<T> source)

    -
    Copies the values of the given Vector<T> to the diagonal.
    +

    void SetDiagonal(Complex[] source)

    +
    Copies the values of the given array to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3459,8 +3480,8 @@ this[i,i].
    Parameters
    -
    Vector<T> source
    -

    The vector to copy the values from. The length of the vector should be +

    Complex[] source
    +

    The array to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3477,8 +3498,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3486,10 +3507,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3498,8 +3515,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3507,6 +3524,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3515,7 +3536,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3524,16 +3545,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3565,7 +3578,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3574,8 +3587,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3584,7 +3605,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3593,13 +3614,10 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    -
    @@ -3624,7 +3642,7 @@ Min(Rows, Columns).

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3633,10 +3651,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3655,6 +3676,24 @@ Min(Rows, Columns).

    +
    +
    +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    @@ -3681,42 +3720,6 @@ Min(Rows, Columns).

    The result matrix X.

    -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - -
    @@ -3743,10 +3746,28 @@ Min(Rows, Columns).

    The result vector x.

    + + +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3755,15 +3776,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3772,13 +3796,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -3924,7 +3945,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(Complex scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(Complex scalar)

    @@ -3933,7 +3954,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(Complex scalar)

    +

    void SubtractFrom(Complex scalar, Matrix<T> result)

    @@ -3994,8 +4015,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4003,8 +4024,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4012,8 +4033,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    +
    @@ -4021,8 +4042,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    +
    @@ -4030,7 +4051,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4039,7 +4060,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4075,9 +4096,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4085,10 +4107,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4185,6 +4206,26 @@ The format string is ignored.
    +
    +
    +
    +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    +
    @@ -4239,49 +4280,6 @@ The format string is ignored.
    -
    -
    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    - -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    - -
    -
    -
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The solution matrix B.

    -
    Matrix<T> result
    -

    The result matrix X

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    @@ -4294,7 +4292,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4303,7 +4301,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4312,10 +4310,24 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    Matrix<T> result
    +

    The result matrix X

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    @@ -4343,17 +4355,12 @@ The format string is ignored.
    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    -
    @@ -4370,6 +4377,20 @@ The format string is ignored.
    +
    +
    +
    +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    +
    +
    @@ -4400,7 +4421,7 @@ The format string is ignored. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/Matrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/Matrix.htm index 93700652..5a09c9ea 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/Matrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/Matrix.htm @@ -366,6 +366,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -459,7 +460,7 @@

    Public Methods

    -

    void Add(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Add(Matrix<T> other)

    Adds another matrix to this matrix. @@ -468,30 +469,22 @@
    Matrix<T> other

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the addition.

    +
    -

    Matrix<T> Add(Matrix<T> other)

    -
    Adds another matrix to this matrix. - +

    Matrix<T> Add(Complex scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to add to this matrix.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the addition.

    -
    @@ -505,10 +498,18 @@
    -

    Matrix<T> Add(Complex scalar)

    -
    +

    void Add(Matrix<T> other, Matrix<T> result)

    +
    Adds another matrix to this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    +
    @@ -613,15 +614,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    - -
    -

    void At(int row, int column, Complex value)

    -
    - - - -
    @@ -644,6 +636,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    + + +
    +

    void At(int row, int column, Complex value)

    +
    + + + +
    @@ -724,8 +725,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(Func<Complex, bool> zeroPredicate)

    -
    Set all values that meet the predicate to zero, in-place. +

    void CoerceZero(double threshold)

    +
    Set all values whose absolute value is smaller than the threshold to zero. @@ -733,8 +734,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(double threshold)

    -
    Set all values whose absolute value is smaller than the threshold to zero. +

    void CoerceZero(Func<Complex, bool> zeroPredicate)

    +
    Set all values that meet the predicate to zero, in-place. @@ -742,8 +743,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. +

    void Column(int index, Vector<T> result)

    +
    Copies a column into to the given Vector.
    @@ -751,19 +752,16 @@ Use ToRowMajorArray instead if you always need an independent array.
    int index

    The column to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    -

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    -
    Copies the requested column elements into a new Vector. +

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    +
    Copies the requested column elements into the given vector.
    @@ -775,51 +773,54 @@ Use ToRowMajorArray instead if you always need an independent array.

    The row to start copying from.

    int length

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the requested elements.

    -
    -

    void Column(int index, Vector<T> result)

    -
    Copies a column into to the given Vector. +

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    +
    Copies the requested column elements into a new Vector.
    Parameters
    -
    int index
    -

    The column to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int columnIndex
    +

    The column to copy elements from.

    +
    int rowIndex
    +

    The row to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the requested elements.

    +
    -

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    -
    Copies the requested column elements into the given vector. +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>.
    Parameters
    -
    int columnIndex
    -

    The column to copy elements from.

    -
    int rowIndex
    -

    The row to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The column to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    @@ -865,21 +866,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The condition number of the matrix.

    -
    -
    -
    -

    void Conjugate(Matrix<T> result)

    -
    Complex conjugate each element of this matrix and place the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The result of the conjugation.

    -
    - -
    @@ -896,11 +882,17 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. +
    +

    void Conjugate(Matrix<T> result)

    +
    Complex conjugate each element of this matrix and place the results into the result matrix. + +
    +
    Parameters
    +
    Matrix<T> result
    +

    The result of the conjugation.

    +
    @@ -919,23 +911,12 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result. - +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -956,26 +937,9 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +
    +

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result.
    @@ -1028,6 +992,43 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + + +
    +
    +
    +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    +
    @@ -1622,7 +1623,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1632,18 +1633,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1653,10 +1651,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -1789,8 +1790,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -1798,8 +1799,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -1913,34 +1914,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Complex scalar, Matrix<T> result)

    -
    - - - - -
    -
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    Vector<T> Multiply(Vector<T> rightSide)

    +
    Multiplies this matrix by a vector and returns the result.
    @@ -1948,36 +1923,39 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Vector<T> rightSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> Multiply(Vector<T> rightSide)

    -
    Multiplies this matrix by a vector and returns the result. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    Return
    -
    Vector<T>
    +
    Matrix<T>

    The result of the multiplication.

    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix.
    @@ -1985,13 +1963,10 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2004,17 +1979,29 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +
    +

    void Multiply(Complex scalar, Matrix<T> result)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    + +
    +
    +
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2031,6 +2018,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2119,15 +2120,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMaximum(Complex scalar)

    -
    - - - -
    @@ -2169,6 +2161,24 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAbsoluteMaximum(Complex scalar)

    +
    + + + + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(Complex scalar, Matrix<T> result)

    +
    + + + +
    @@ -2187,7 +2197,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Complex scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Complex scalar)

    @@ -2210,15 +2220,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    - -
    -

    Matrix<T> PointwiseAbsoluteMinimum(Complex scalar)

    -
    - - - -
    @@ -2294,31 +2295,31 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The other matrix 'y'

    -
    Matrix<T> result
    -

    The matrix with the result and 'x'

    -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The other matrix 'y'

    +
    Matrix<T> result
    +

    The matrix with the result and 'x'

    +
    @@ -2348,34 +2349,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCos(Matrix<T> result)

    +

    Matrix<T> PointwiseCos()

    Pointwise applies the cos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCos()

    +

    void PointwiseCos(Matrix<T> result)

    Pointwise applies the cos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseCosh()

    -
    Pointwise applies the cosh function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2393,6 +2385,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    + + +
    +

    Matrix<T> PointwiseCosh()

    +
    Pointwise applies the cosh function to each value + + + +
    @@ -2454,6 +2455,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    + +
    +

    Matrix<T> PointwiseFloor()

    +
    Pointwise applies the floor function to each value + + + +
    @@ -2471,9 +2481,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseFloor()

    -
    Pointwise applies the floor function to each value +
    +

    Matrix<T> PointwiseLog()

    +
    Pointwise applies the natural logarithm function to each value. @@ -2495,9 +2505,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseLog()

    -
    Pointwise applies the natural logarithm function to each value. +
    +

    Matrix<T> PointwiseLog10()

    +
    Pointwise applies the log10 function to each value @@ -2517,19 +2527,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    Matrix<T> PointwiseLog10()

    -
    Pointwise applies the log10 function to each value - - - -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2538,6 +2539,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -2562,7 +2565,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2571,8 +2574,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2750,9 +2751,9 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    +

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix and stores the result into the result matrix. +of this matrix by another matrix.
    @@ -2760,17 +2761,15 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise remainder.

    -

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    +

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix. +of this matrix by another matrix and stores the result into the result matrix.
    @@ -2778,6 +2777,8 @@ of this matrix by another matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise remainder.

    @@ -3117,6 +3118,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3305,10 +3329,22 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Complex[] row)

    -
    +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row. +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> row
    +

    The vector to copy the values from.

    +
    @@ -3331,22 +3367,10 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Complex[] row)

    +
    -
    -
    Parameters
    - -
    int rowIndex
    -

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> row
    -

    The vector to copy the values from.

    -
    @@ -3421,27 +3445,27 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    Matrix<T> Solve(Matrix<T> input)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Vector<T> input
    -

    The right hand side vector, .

    +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    +
    Matrix<T>
    +

    The left hand side Matrix`1 , .

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3450,24 +3474,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    -

    void Solve(Matrix<T> input, Matrix<T> result)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    +
    Vector<T> input
    +

    The right hand side vector, .

    +
    Vector<T> result

    The left hand side Matrix`1 , .

    @@ -3475,7 +3502,7 @@ Min(Rows, Columns).

    -

    Matrix<T> Solve(Matrix<T> input)

    +

    void Solve(Matrix<T> input, Matrix<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3484,18 +3511,15 @@ Min(Rows, Columns).

    Matrix<T> input

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Matrix<T>
    -

    The left hand side Matrix`1 , .

    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3530,33 +3554,16 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Matrix<T> input
    -

    The solution matrix B.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result matrix X.

    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -3565,7 +3572,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3574,11 +3581,28 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result matrix X.

    +
    @@ -3620,32 +3644,32 @@ Min(Rows, Columns).

    -

    void StrictlyLowerTriangle(Matrix<T> result)

    -
    Puts the strictly lower triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyLowerTriangle()

    +
    Returns a new matrix containing the lower triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The lower triangle of this matrix.

    -
    -

    Matrix<T> StrictlyLowerTriangle()

    -
    Returns a new matrix containing the lower triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyLowerTriangle(Matrix<T> result)

    +
    Puts the strictly lower triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The lower triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -3706,18 +3730,10 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - +

    void Subtract(Complex scalar, Matrix<T> result)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    @@ -3743,10 +3759,18 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(Complex scalar, Matrix<T> result)

    -
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    @@ -3761,7 +3785,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(Complex scalar)

    +

    void SubtractFrom(Complex scalar, Matrix<T> result)

    @@ -3770,7 +3794,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(Complex scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(Complex scalar)

    @@ -3831,8 +3855,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -3840,8 +3864,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    +
    @@ -3849,7 +3873,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex, string> formatValue)

    @@ -3867,7 +3891,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3876,7 +3900,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3923,9 +3947,8 @@ The format string is ignored.
    -

    string ToString()

    -
    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    +
    Returns a string that summarizes this matrix. @@ -3933,8 +3956,9 @@ The maximum number of cells can be configured in the -

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    -
    Returns a string that summarizes this matrix. +

    string ToString()

    +
    Returns a string that summarizes this matrix. +The maximum number of cells can be configured in the Control class. @@ -3988,8 +4012,8 @@ The maximum number of cells can be configured in the -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix.
    @@ -3997,19 +4021,16 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix. +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result.
    @@ -4017,16 +4038,19 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4034,13 +4058,10 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -4082,8 +4103,8 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4091,8 +4112,34 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    + +
    +
    +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. + + +
    +
    Parameters
    + +
    Vector<T> input
    +

    The solution vector b.

    +
    Vector<T> result
    +

    The result vector x.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    @@ -4155,29 +4202,6 @@ The maximum number of cells can be configured in the -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - -
    -
    Parameters
    - -
    Vector<T> input
    -

    The solution vector b.

    -
    Vector<T> result
    -

    The result vector x.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/SparseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/SparseMatrix.htm index de76e1be..624e3351 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/SparseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/SparseMatrix.htm @@ -402,6 +402,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -496,8 +497,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..

    SparseMatrix(int rows, int columns)

    Create a new sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -519,8 +519,7 @@ storage for performance or interop reasons.

    SparseMatrix(int order)

    Create a new square sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -661,7 +660,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalArray(Complex[] diagonal)

    +

    SparseMatrix OfDiagonalArray(int rows, int columns, Complex[] diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -672,7 +671,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalArray(int rows, int columns, Complex[] diagonal)

    +

    SparseMatrix OfDiagonalArray(Complex[] diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -1631,18 +1630,6 @@ The enumerator will include all values, even if they are zero. -
    -
    -
    -

    IEnumerable<Tuple<int, Vector<Complex>>> EnumerateRowsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the row index -and the second value being the value of the row at that index. -
    - - - -
    @@ -1663,6 +1650,18 @@ and the second value being the value of the row at that index.
    +
    +
    +
    +

    IEnumerable<Tuple<int, Vector<Complex>>> EnumerateRowsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the row index +and the second value being the value of the row at that index. +
    + + + +
    @@ -2031,8 +2030,8 @@ In a later release, it will be replaced with a sparse implementation.
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -2040,19 +2039,16 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -2060,10 +2056,13 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    @@ -2128,8 +2127,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -2137,8 +2136,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<Complex, Complex, Complex> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -2272,16 +2271,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -2318,16 +2317,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result

    The result of the multiplication.

    @@ -2344,31 +2343,31 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Negate(Matrix<T> result)

    -
    Negate each element of this matrix and place the results into the result matrix. +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    The result of the negation.

    +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +

    void Negate(Matrix<T> result)

    +
    Negate each element of this matrix and place the results into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    +
    Matrix<T> result
    +

    The result of the negation.

    +
    @@ -2461,10 +2460,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(Complex scalar)

    -
    +

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    +
    Pointwise applies the absolute maximum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2496,22 +2501,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    -
    Pointwise applies the absolute maximum with the values of another matrix to each value. - +

    Matrix<T> PointwiseAbsoluteMaximum(Complex scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2520,15 +2519,13 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -

    void PointwiseAbsoluteMinimum(Complex scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Complex scalar)

    @@ -2537,7 +2534,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(Complex scalar)

    +

    void PointwiseAbsoluteMinimum(Complex scalar, Matrix<T> result)

    @@ -2546,7 +2543,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2555,40 +2552,33 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseAcos(Matrix<T> result)

    +

    Matrix<T> PointwiseAcos()

    Pointwise applies the acos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAcos()

    +

    void PointwiseAcos(Matrix<T> result)

    Pointwise applies the acos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseAsin()

    -
    Pointwise applies the asin function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2606,6 +2596,15 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAsin()

    +
    Pointwise applies the asin function to each value + + + +
    @@ -2711,32 +2710,32 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCosh(Matrix<T> result)

    +

    Matrix<T> PointwiseCosh()

    Pointwise applies the cosh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCosh()

    +

    void PointwiseCosh(Matrix<T> result)

    Pointwise applies the cosh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    -
    Pointwise divide this matrix by another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    +
    Pointwise divide this matrix by another matrix.
    @@ -2744,16 +2743,19 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise division.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise division of this matrix and divisor.

    +
    -

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    -
    Pointwise divide this matrix by another matrix. +

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    +
    Pointwise divide this matrix by another matrix and stores the result into the result matrix.
    @@ -2761,13 +2763,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise division.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise division of this matrix and divisor.

    -
    @@ -2796,25 +2795,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseFloor(Matrix<T> result)

    +

    Matrix<T> PointwiseFloor()

    Pointwise applies the floor function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseFloor()

    +

    void PointwiseFloor(Matrix<T> result)

    Pointwise applies the floor function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2844,25 +2843,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2880,15 +2879,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    void PointwiseMaximum(Complex scalar, Matrix<T> result)

    -
    - - - -
    @@ -2906,6 +2896,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    void PointwiseMaximum(Complex scalar, Matrix<T> result)

    +
    + + + +
    @@ -2950,7 +2949,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(Complex scalar)

    +

    void PointwiseMinimum(Complex scalar, Matrix<T> result)

    @@ -2959,7 +2958,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Complex scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMinimum(Complex scalar)

    @@ -3039,7 +3038,7 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(Complex exponent)

    +

    void PointwisePower(Complex exponent, Matrix<T> result)

    @@ -3048,32 +3047,34 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(Matrix<T> exponent)

    -
    Pointwise raise this matrix to an exponent and store the result into the result matrix. - +

    Matrix<T> PointwisePower(Complex exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    -

    void PointwisePower(Complex exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. +
    +
    Parameters
    + +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(Matrix<T> exponent)

    +
    Pointwise raise this matrix to an exponent and store the result into the result matrix.
    @@ -3081,8 +3082,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> exponent

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    @@ -3456,6 +3455,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3566,23 +3588,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Vector<T> column)

    -
    Copies the values of the given Vector to the specified column. - - -
    -
    Parameters
    - -
    int columnIndex
    -

    The column to copy the values to.

    -
    Vector<T> column
    -

    The vector to copy the values from.

    -
    - -
    @@ -3613,6 +3618,23 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Vector<T> column)

    +
    Copies the values of the given Vector to the specified column. + + +
    +
    Parameters
    + +
    int columnIndex
    +

    The column to copy the values to.

    +
    Vector<T> column
    +

    The vector to copy the values from.

    +
    + +
    @@ -3641,6 +3663,15 @@ Min(Rows, Columns).

    +
    +
    +
    +

    void SetRow(int rowIndex, Complex[] row)

    +
    + + + +
    @@ -3679,19 +3710,10 @@ Min(Rows, Columns).

    -
    -
    -
    -

    void SetRow(int rowIndex, Complex[] row)

    -
    - - - -
    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3700,8 +3722,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3733,7 +3763,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3742,16 +3772,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3760,24 +3782,7 @@ Min(Rows, Columns).

    -

    void Solve(Matrix<T> input, Matrix<T> result)

    -
    Solves a system of linear equations, , with A QR factorized. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    -

    The left hand side Matrix`1 , .

    -
    - - -
    -
    -
    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3786,10 +3791,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3814,7 +3822,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3823,13 +3831,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    + +
    +
    +
    +

    void Solve(Matrix<T> input, Matrix<T> result)

    +
    Solves a system of linear equations, , with A QR factorized. + + +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    +
    @@ -3904,7 +3926,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3913,7 +3935,7 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3922,7 +3944,7 @@ Min(Rows, Columns).

    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3931,15 +3953,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3948,13 +3973,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -4045,7 +4067,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Matrix<T> other)

    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    Subtracts another matrix from this matrix. @@ -4054,13 +4076,10 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the subtraction.

    -
    @@ -4074,16 +4093,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Complex scalar)

    -
    - - - - -
    -
    -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Subtract(Matrix<T> other)

    Subtracts another matrix from this matrix. @@ -4092,15 +4102,18 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the subtraction.

    +
    -
    -

    void SubtractFrom(Complex scalar, Matrix<T> result)

    +
    +

    Matrix<T> Subtract(Complex scalar)

    @@ -4115,6 +4128,15 @@ does not contain the diagonal elements of this matrix. +
    +
    +
    +

    void SubtractFrom(Complex scalar, Matrix<T> result)

    +
    + + + +
    @@ -4188,7 +4210,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4197,7 +4219,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +

    string ToMatrixString(string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4260,9 +4282,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4270,10 +4293,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4301,6 +4323,15 @@ The format string is ignored.

    The trace of this matrix

    +
    +
    +
    +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4317,12 +4348,23 @@ The format string is ignored.
    -
    -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. +
    +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4343,9 +4385,9 @@ The format string is ignored.
    -
    -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4353,19 +4395,16 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. +

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the transpose of this matrix with a vector and places the results into the result vector.
    @@ -4373,56 +4412,36 @@ The format string is ignored.
    Vector<T> rightSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    Return
    -
    Matrix<T>
    +
    Vector<T>

    The result of the multiplication.

    -

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4430,10 +4449,13 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4484,7 +4506,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4493,7 +4515,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4502,7 +4524,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4511,7 +4533,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4584,7 +4606,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/SparseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/SparseVector.htm index 4c50aa8c..71db1d9e 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/SparseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/SparseVector.htm @@ -362,8 +362,7 @@

    SparseVector(int length)

    Create a new sparse vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2605,7 +2604,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/Vector.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/Vector.htm index cbc8b793..13372907 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/Vector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/Vector.htm @@ -2458,7 +2458,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex/index.htm b/api/MathNet.Numerics.LinearAlgebra.Complex/index.htm index e40d4270..ca53d526 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex/index.htm @@ -167,7 +167,7 @@
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/BiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/BiCgStab.htm index 16fb0e7e..9d334fe8 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/BiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/BiCgStab.htm @@ -271,7 +271,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/CompositeSolver.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/CompositeSolver.htm index a942c81b..d02b3e5b 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/CompositeSolver.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/CompositeSolver.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/DiagonalPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/DiagonalPreconditioner.htm index 115530a3..aad28d1e 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/DiagonalPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/DiagonalPreconditioner.htm @@ -272,7 +272,7 @@ of the matrix diagonal as preconditioning values. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/GpBiCg.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/GpBiCg.htm index 65bff8c7..9300408d 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/GpBiCg.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/GpBiCg.htm @@ -291,7 +291,7 @@ before switching over to the BiCgStab algorithm. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILU0Preconditioner.htm index aebab077..e23f6e48 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILU0Preconditioner.htm @@ -273,7 +273,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILUTPPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILUTPPreconditioner.htm index 1070f6a0..0ac7988f 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILUTPPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/ILUTPPreconditioner.htm @@ -384,7 +384,7 @@ the preconditioner.

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MILU0Preconditioner.htm index bf0bf353..9e358512 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MILU0Preconditioner.htm @@ -298,7 +298,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MlkBiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MlkBiCgStab.htm index 7beef51a..c4acd475 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MlkBiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/MlkBiCgStab.htm @@ -299,7 +299,7 @@ Krylov sub-space. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/TFQMR.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/TFQMR.htm index 9e042d37..4d37b7e7 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/TFQMR.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/TFQMR.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm index 1ae3f95e..55403b28 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm @@ -175,7 +175,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseMatrix.htm index 6f819555..8991cce5 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseMatrix.htm @@ -402,6 +402,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -507,8 +508,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    DenseMatrix(int rows, int columns)

    Create a new dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -518,8 +518,7 @@ Zero-length matrices are not supported.

    DenseMatrix(int order)

    Create a new square dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -542,8 +541,8 @@ storage for performance or interop reasons.

    Public Static Functions

    -

    DenseMatrix Create(int rows, int columns, Complex32 value)

    -
    Create a new dense matrix and initialize each value to the same provided value. +

    DenseMatrix Create(int rows, int columns, Func<int, int, Complex32> init)

    +
    Create a new dense matrix and initialize each value using the provided init function. @@ -551,8 +550,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix Create(int rows, int columns, Func<int, int, Complex32> init)

    -
    Create a new dense matrix and initialize each value using the provided init function. +

    DenseMatrix Create(int rows, int columns, Complex32 value)

    +
    Create a new dense matrix and initialize each value to the same provided value. @@ -560,8 +559,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix CreateDiagonal(int rows, int columns, Complex32 value)

    -
    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. +

    DenseMatrix CreateDiagonal(int rows, int columns, Func<int, Complex32> init)

    +
    Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. @@ -569,8 +568,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix CreateDiagonal(int rows, int columns, Func<int, Complex32> init)

    -
    Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. +

    DenseMatrix CreateDiagonal(int rows, int columns, Complex32 value)

    +
    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. @@ -605,8 +604,10 @@ storage for performance or interop reasons.
    -

    DenseMatrix OfColumnArrays(Complex32[][] columns)

    -
    +

    DenseMatrix OfColumnArrays(IEnumerable<Complex32[]> columns)

    +
    Create a new dense matrix as a copy of the given column arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -614,10 +615,8 @@ storage for performance or interop reasons.
    -

    DenseMatrix OfColumnArrays(IEnumerable<Complex32[]> columns)

    -
    Create a new dense matrix as a copy of the given column arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    DenseMatrix OfColumnArrays(Complex32[][] columns)

    +
    @@ -637,7 +636,7 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumns(int rows, int columns, IEnumerable<IEnumerable<Complex32>> data)

    +

    DenseMatrix OfColumns(IEnumerable<IEnumerable<Complex32>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable columns. Each enumerable in the master enumerable specifies a column. This new matrix will be independent from the enumerables. @@ -649,7 +648,7 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumns(IEnumerable<IEnumerable<Complex32>> data)

    +

    DenseMatrix OfColumns(int rows, int columns, IEnumerable<IEnumerable<Complex32>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable columns. Each enumerable in the master enumerable specifies a column. This new matrix will be independent from the enumerables. @@ -815,7 +814,7 @@ A new memory block will be allocated for storing the matrix.

    Public Methods

    -

    Matrix<T> Add(Complex32 scalar)

    +

    void Add(Complex32 scalar, Matrix<T> result)

    @@ -824,10 +823,18 @@ A new memory block will be allocated for storing the matrix.
    -

    void Add(Complex32 scalar, Matrix<T> result)

    -
    +

    void Add(Matrix<T> other, Matrix<T> result)

    +
    Adds another matrix to this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    +
    @@ -853,18 +860,10 @@ A new memory block will be allocated for storing the matrix.
    -

    void Add(Matrix<T> other, Matrix<T> result)

    -
    Adds another matrix to this matrix. - +

    Matrix<T> Add(Complex32 scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    -
    @@ -969,15 +968,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    -
    -
    -

    void At(int row, int column, Complex32 value)

    -
    - - - -
    @@ -1000,6 +990,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    +
    +
    +
    +

    void At(int row, int column, Complex32 value)

    +
    + + + +
    @@ -1077,15 +1076,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    A clone of the instance.

    -
    -
    -
    -

    void CoerceZero(Func<Complex32, bool> zeroPredicate)

    -
    Set all values that meet the predicate to zero, in-place. - - - -
    @@ -1097,23 +1087,12 @@ Use ToRowMajorArray instead if you always need an independent array.
    -
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. - +
    +

    void CoerceZero(Func<Complex32, bool> zeroPredicate)

    +
    Set all values that meet the predicate to zero, in-place. -
    -
    Parameters
    -
    int index
    -

    The column to copy.

    -
    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    @@ -1177,6 +1156,26 @@ Use ToRowMajorArray instead if you always need an independent array.
    +
    +
    +
    +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>. + + +
    +
    Parameters
    + +
    int index
    +

    The column to copy.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    +
    @@ -1221,20 +1220,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The condition number of the matrix.

    -
    -
    -
    -

    Matrix<T> Conjugate()

    -
    Complex conjugate each element of this matrix. - - - -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the conjugated values.

    -
    -
    @@ -1252,16 +1237,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    Matrix<T> ConjugateTranspose()

    -
    Returns the conjugate transpose of this matrix. +
    +

    Matrix<T> Conjugate()

    +
    Complex conjugate each element of this matrix.
    Return
    Matrix<T>
    -

    The conjugate transpose of this matrix.

    +

    A matrix containing the conjugated values.

    @@ -1275,20 +1260,17 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. +
    +

    Matrix<T> ConjugateTranspose()

    +
    Returns the conjugate transpose of this matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The conjugate transpose of this matrix.

    -
    @@ -1312,9 +1294,9 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +
    +

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix.
    @@ -1327,6 +1309,26 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    +
    @@ -1367,8 +1369,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -1376,13 +1378,10 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -1472,7 +1471,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    Matrix<T> Divide(Complex32 scalar)

    +

    void Divide(Complex32 scalar, Matrix<T> result)

    @@ -1481,7 +1480,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    void Divide(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> Divide(Complex32 scalar)

    @@ -1490,7 +1489,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    Matrix<T> DivideByThis(Complex32 scalar)

    +

    void DivideByThis(Complex32 scalar, Matrix<T> result)

    @@ -1499,7 +1498,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    void DivideByThis(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> DivideByThis(Complex32 scalar)

    @@ -1508,7 +1507,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    IEnumerable<Complex32> Enumerate()

    +

    IEnumerable<Complex32> Enumerate(Zeros zeros)

    Returns an IEnumerable that can be used to iterate through all values of the matrix.
    The enumerator will include all values, even if they are zero. The ordering of the values is unspecified (not necessarily column-wise or row-wise). @@ -1520,7 +1519,7 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    -

    IEnumerable<Complex32> Enumerate(Zeros zeros)

    +

    IEnumerable<Complex32> Enumerate()

    Returns an IEnumerable that can be used to iterate through all values of the matrix.
    The enumerator will include all values, even if they are zero. The ordering of the values is unspecified (not necessarily column-wise or row-wise). @@ -1529,15 +1528,6 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi -
    -
    -
    -

    IEnumerable<Vector<Complex32>> EnumerateColumns()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - -
    @@ -1555,6 +1545,15 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    +
    +
    +
    +

    IEnumerable<Vector<Complex32>> EnumerateColumns()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. + + + +
    @@ -1613,6 +1612,15 @@ The enumerator will include all values, even if they are zero. +
    +
    +
    +

    IEnumerable<Vector<Complex32>> EnumerateRows()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix. + + + +
    @@ -1632,9 +1640,12 @@ The enumerator will include all values, even if they are zero.
    -
    -

    IEnumerable<Vector<Complex32>> EnumerateRows()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix. +
    +

    IEnumerable<Tuple<int, Vector<Complex32>>> EnumerateRowsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the row index +and the second value being the value of the row at that index. +
    @@ -1659,56 +1670,44 @@ and the second value being the value of the row at that index.
    -
    -
    -
    -

    IEnumerable<Tuple<int, Vector<Complex32>>> EnumerateRowsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the row index -and the second value being the value of the row at that index. -
    - - - -
    -

    bool Equals(Matrix<T> other)

    -
    Indicates whether the current object is equal to another object of the same type. +

    bool Equals(object obj)

    +
    Determines whether the specified Object is equal to this instance.
    Parameters
    -
    Matrix<T> other
    -

    An object to compare with this object.

    +
    object obj
    +

    The Object to compare with this instance.

    Return
    bool
    -

    true if the current object is equal to the other parameter; otherwise, false.

    +

    true if the specified Object is equal to this instance; otherwise, false.

    -

    bool Equals(object obj)

    -
    Determines whether the specified Object is equal to this instance. +

    bool Equals(Matrix<T> other)

    +
    Indicates whether the current object is equal to another object of the same type.
    Parameters
    -
    object obj
    -

    The Object to compare with this instance.

    +
    Matrix<T> other
    +

    An object to compare with this object.

    Return
    bool
    -

    true if the specified Object is equal to this instance; otherwise, false.

    +

    true if the current object is equal to the other parameter; otherwise, false.

    @@ -1978,7 +1977,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1988,18 +1987,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -2009,10 +2005,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -2048,8 +2047,8 @@ In a later release, it will be replaced with a sparse implementation.
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -2057,16 +2056,19 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -2074,13 +2076,10 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    - -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    +
    @@ -2251,7 +2250,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void ModulusByThis(Complex32 dividend, Matrix<T> result)

    +

    Matrix<T> ModulusByThis(Complex32 dividend)

    @@ -2260,7 +2259,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> ModulusByThis(Complex32 dividend)

    +

    void ModulusByThis(Complex32 dividend, Matrix<T> result)

    @@ -2323,6 +2322,23 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    + +
    +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -2343,18 +2359,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. +
    +

    void Negate(Matrix<T> result)

    +
    Negate each element of this matrix and place the results into the result matrix.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    Matrix<T> result
    -

    The result of the multiplication.

    +

    The result of the negation.

    @@ -2372,21 +2386,6 @@ on the actual data storage implementation (relevant mostly for sparse matrices).

    A matrix containing the negated values.

    -
    -
    -
    -

    void Negate(Matrix<T> result)

    -
    Negate each element of this matrix and place the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The result of the negation.

    -
    - -
    @@ -2454,25 +2453,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbs(Matrix<T> result)

    +

    Matrix<T> PointwiseAbs()

    Pointwise applies the abs function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAbs()

    +

    void PointwiseAbs(Matrix<T> result)

    Pointwise applies the abs function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2528,18 +2527,19 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the absolute minimum with the values of another matrix to each value. +

    Matrix<T> PointwiseAbsoluteMinimum(Complex32 scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(Complex32 scalar, Matrix<T> result)

    +
    + +
    @@ -2560,19 +2560,18 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Complex32 scalar, Matrix<T> result)

    -
    - - +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +
    Pointwise applies the absolute minimum with the values of another matrix to each value. - -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMinimum(Complex32 scalar)

    -
    +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    @@ -2602,25 +2601,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAsin(Matrix<T> result)

    +

    Matrix<T> PointwiseAsin()

    Pointwise applies the asin function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAsin()

    +

    void PointwiseAsin(Matrix<T> result)

    Pointwise applies the asin function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2647,17 +2646,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    - - -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    -
    Pointwise applies the atan2 function to each value of the current -matrix and a given other matrix being the 'x' of atan2 and the -'this' matrix being the 'y' - - - -
    @@ -2679,9 +2667,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCeiling()

    -
    Pointwise applies the ceiling function to each value +
    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +
    Pointwise applies the atan2 function to each value of the current +matrix and a given other matrix being the 'x' of atan2 and the +'this' matrix being the 'y' @@ -2703,9 +2693,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCos()

    -
    Pointwise applies the cos function to each value +
    +

    Matrix<T> PointwiseCeiling()

    +
    Pointwise applies the ceiling function to each value @@ -2725,6 +2715,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    Matrix<T> PointwiseCos()

    +
    Pointwise applies the cos function to each value + + + +
    @@ -2861,31 +2860,31 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2894,13 +2893,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2909,8 +2910,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2935,18 +2934,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(Complex32 scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2961,16 +2952,22 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(Complex32 scalar)

    -
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2979,6 +2976,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -3056,24 +3055,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. - +

    Matrix<T> PointwisePower(Complex32 exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    -

    Matrix<T> PointwisePower(Complex32 exponent)

    +

    void PointwisePower(Complex32 exponent, Matrix<T> result)

    @@ -3082,10 +3073,18 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(Complex32 exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. +
    +
    Parameters
    + +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -3236,25 +3235,25 @@ of this matrix by another matrix.
    -

    Matrix<T> PointwiseSqrt()

    +

    void PointwiseSqrt(Matrix<T> result)

    Pointwise applies the sqrt function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseSqrt(Matrix<T> result)

    +

    Matrix<T> PointwiseSqrt()

    Pointwise applies the sqrt function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -3284,32 +3283,32 @@ of this matrix by another matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3317,16 +3316,14 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3334,6 +3331,8 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    @@ -3473,6 +3472,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3661,8 +3683,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3670,10 +3692,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3682,8 +3700,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3691,6 +3709,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3851,20 +3873,28 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    +
    +
    Parameters
    +
    Vector<T> input
    +

    The solution vector b.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Vector<T>
    +

    The result vector x.

    +
    @@ -3895,28 +3925,20 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Vector<T> input
    -

    The solution vector b.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + -
    -
    Return
    -
    Vector<T>
    -

    The result vector x.

    -
    @@ -3930,7 +3952,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4006,32 +4028,32 @@ does not contain the diagonal elements of this matrix.
    -

    void StrictlyUpperTriangle(Matrix<T> result)

    -
    Puts the strictly upper triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyUpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> StrictlyUpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyUpperTriangle(Matrix<T> result)

    +
    Puts the strictly upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4059,6 +4081,23 @@ does not contain the diagonal elements of this matrix.

    The requested sub-matrix.

    +
    +
    +
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    + +
    @@ -4097,23 +4136,6 @@ does not contain the diagonal elements of this matrix.

    The result of the subtraction.

    -
    - -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    - -
    @@ -4187,8 +4209,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4205,8 +4227,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    +
    @@ -4214,7 +4236,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4318,15 +4340,6 @@ The maximum number of cells can be configured in the -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. - - - -
    @@ -4341,6 +4354,15 @@ The maximum number of cells can be configured in the +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4378,6 +4400,23 @@ The maximum number of cells can be configured in the +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -4435,23 +4474,6 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -4537,31 +4559,31 @@ The maximum number of cells can be configured in the -

    void UpperTriangle(Matrix<T> result)

    -
    Puts the upper triangle of this matrix into the result matrix. +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +

    void UpperTriangle(Matrix<T> result)

    +
    Puts the upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4601,7 +4623,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseVector.htm index fd6a29e4..2f022f49 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/DenseVector.htm @@ -374,8 +374,7 @@ Very efficient, but changes to the array and the vector will affect each other.

    DenseVector(int length)

    Create a new dense vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2637,7 +2636,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/DiagonalMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/DiagonalMatrix.htm index 50066be0..855dd4c0 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/DiagonalMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/DiagonalMatrix.htm @@ -389,6 +389,7 @@ entries are set. The exception to this is when the off diagonal elements are
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -505,8 +506,7 @@ storage for performance or interop reasons.

    DiagonalMatrix(int order)

    Create a new square diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -516,8 +516,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns)

    Create a new diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -527,8 +526,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns, Complex32 diagonalValue)

    Create a new diagonal matrix with the given number of rows and columns. -All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. -Zero-length matrices are not supported. +All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. @@ -1470,41 +1468,41 @@ and the second value being the value of the row at that index.
    -

    bool Equals(object obj)

    -
    Determines whether the specified Object is equal to this instance. +

    bool Equals(Matrix<T> other)

    +
    Indicates whether the current object is equal to another object of the same type.
    Parameters
    -
    object obj
    -

    The Object to compare with this instance.

    +
    Matrix<T> other
    +

    An object to compare with this object.

    Return
    bool
    -

    true if the specified Object is equal to this instance; otherwise, false.

    +

    true if the current object is equal to the other parameter; otherwise, false.

    -

    bool Equals(Matrix<T> other)

    -
    Indicates whether the current object is equal to another object of the same type. +

    bool Equals(object obj)

    +
    Determines whether the specified Object is equal to this instance.
    Parameters
    -
    Matrix<T> other
    -

    An object to compare with this object.

    +
    object obj
    +

    The Object to compare with this instance.

    Return
    bool
    -

    true if the current object is equal to the other parameter; otherwise, false.

    +

    true if the specified Object is equal to this instance; otherwise, false.

    @@ -1774,7 +1772,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1784,15 +1782,18 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1802,13 +1803,10 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    @@ -2044,7 +2042,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void ModulusByThis(Complex32 dividend, Matrix<T> result)

    +

    Matrix<T> ModulusByThis(Complex32 dividend)

    @@ -2053,7 +2051,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> ModulusByThis(Complex32 dividend)

    +

    void ModulusByThis(Complex32 dividend, Matrix<T> result)

    @@ -2634,25 +2632,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog()

    +

    void PointwiseLog(Matrix<T> result)

    Pointwise applies the natural logarithm function to each value. +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    -

    void PointwiseLog(Matrix<T> result)

    +

    Matrix<T> PointwiseLog()

    Pointwise applies the natural logarithm function to each value. -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2679,6 +2677,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    +
    +
    +

    void PointwiseMaximum(Complex32 scalar, Matrix<T> result)

    +
    + + + +
    @@ -2714,7 +2721,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Complex32 scalar)

    @@ -2722,11 +2729,17 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseMaximum(Complex32 scalar)

    -
    +
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. + +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2741,24 +2754,16 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(Complex32 scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2767,18 +2772,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -
    -
    -
    -

    Matrix<T> PointwiseMinimum(Complex32 scalar)

    -
    - - - -
    @@ -2816,8 +2814,8 @@ of this matrix by another matrix.
    -

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    -
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    +
    Pointwise multiplies this matrix with another matrix.
    @@ -2825,16 +2823,19 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise multiplication of this matrix and other.

    +
    -

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    -
    Pointwise multiplies this matrix with another matrix. +

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    +
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix.
    @@ -2842,29 +2843,27 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise multiplication of this matrix and other.

    -
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(Complex32 exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    + +
    +
    +
    +

    void PointwisePower(Complex32 exponent, Matrix<T> result)

    +
    + +
    @@ -2885,19 +2884,18 @@ of this matrix by another matrix.
    -

    void PointwisePower(Complex32 exponent, Matrix<T> result)

    -
    - - +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. - -
    -
    -
    -

    Matrix<T> PointwisePower(Complex32 exponent)

    -
    +
    +
    Parameters
    +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -2937,25 +2935,25 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRound(Matrix<T> result)

    +

    Matrix<T> PointwiseRound()

    Pointwise applies the round function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseRound()

    +

    void PointwiseRound(Matrix<T> result)

    Pointwise applies the round function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -3081,32 +3079,32 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3114,14 +3112,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3129,8 +3129,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    @@ -3272,23 +3270,47 @@ also known as the range or image of the corresponding matrix transformation.
    -
    -

    Vector<T> Row(int index)

    -
    Copies a row into an Vector. +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero.
    Parameters
    -
    int index
    -

    The row to copy.

    +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    + +
    +
    +
    +

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    +
    Copies the requested row elements into a new Vector. + + +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy elements from.

    +
    int columnIndex
    +

    The column to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    +
    @@ -3334,24 +3356,23 @@ also known as the range or image of the corresponding matrix transformation.
    -

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    -
    Copies the requested row elements into a new Vector. +

    Vector<T> Row(int index)

    +
    Copies a row into an Vector.
    Parameters
    -
    int rowIndex
    -

    The row to copy elements from.

    -
    int columnIndex
    -

    The column to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The row to copy.

    - +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    +
    @@ -3380,15 +3401,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Complex32[] column)

    -
    - - - -
    @@ -3427,11 +3439,20 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Complex32[] column)

    +
    + + + +
    -

    void SetDiagonal(Complex32[] source)

    -
    Copies the values of the given array to the diagonal.
    +

    void SetDiagonal(Vector<T> source)

    +
    Copies the values of the given Vector<T> to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3440,8 +3461,8 @@ this[i,i].
    Parameters
    -
    Complex32[] source
    -

    The array to copy the values from. The length of the vector should be +

    Vector<T> source
    +

    The vector to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3449,8 +3470,8 @@ Min(Rows, Columns).

    -

    void SetDiagonal(Vector<T> source)

    -
    Copies the values of the given Vector<T> to the diagonal.
    +

    void SetDiagonal(Complex32[] source)

    +
    Copies the values of the given array to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3459,8 +3480,8 @@ this[i,i].
    Parameters
    -
    Vector<T> source
    -

    The vector to copy the values from. The length of the vector should be +

    Complex32[] source
    +

    The array to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3477,8 +3498,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3486,10 +3507,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3498,8 +3515,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3507,6 +3524,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3515,7 +3536,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3524,16 +3545,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3565,7 +3578,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3574,8 +3587,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3584,7 +3605,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3593,13 +3614,10 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    -
    @@ -3624,7 +3642,7 @@ Min(Rows, Columns).

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3633,10 +3651,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3655,6 +3676,24 @@ Min(Rows, Columns).

    +
    +
    +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    @@ -3681,42 +3720,6 @@ Min(Rows, Columns).

    The result matrix X.

    -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - -
    @@ -3743,10 +3746,28 @@ Min(Rows, Columns).

    The result vector x.

    + + +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3755,15 +3776,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3772,13 +3796,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -3924,7 +3945,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(Complex32 scalar)

    @@ -3933,7 +3954,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(Complex32 scalar)

    +

    void SubtractFrom(Complex32 scalar, Matrix<T> result)

    @@ -3994,8 +4015,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4003,8 +4024,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4012,8 +4033,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    +
    @@ -4021,8 +4042,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    +
    @@ -4030,7 +4051,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4039,7 +4060,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4075,9 +4096,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4085,10 +4107,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4185,6 +4206,26 @@ The format string is ignored.
    +
    +
    +
    +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    +
    @@ -4239,49 +4280,6 @@ The format string is ignored.
    -
    -
    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    - -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    - -
    -
    -
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The solution matrix B.

    -
    Matrix<T> result
    -

    The result matrix X

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    @@ -4294,7 +4292,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4303,7 +4301,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4312,10 +4310,24 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    Matrix<T> result
    +

    The result matrix X

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    @@ -4343,17 +4355,12 @@ The format string is ignored.
    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    -
    @@ -4370,6 +4377,20 @@ The format string is ignored.
    +
    +
    +
    +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    +
    +
    @@ -4400,7 +4421,7 @@ The format string is ignored. diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/Matrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/Matrix.htm index 81bd768f..7aea7e69 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/Matrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/Matrix.htm @@ -366,6 +366,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -459,7 +460,7 @@

    Public Methods

    -

    void Add(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Add(Matrix<T> other)

    Adds another matrix to this matrix. @@ -468,30 +469,22 @@
    Matrix<T> other

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the addition.

    +
    -

    Matrix<T> Add(Matrix<T> other)

    -
    Adds another matrix to this matrix. - +

    Matrix<T> Add(Complex32 scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to add to this matrix.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the addition.

    -
    @@ -505,10 +498,18 @@
    -

    Matrix<T> Add(Complex32 scalar)

    -
    +

    void Add(Matrix<T> other, Matrix<T> result)

    +
    Adds another matrix to this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    +
    @@ -613,15 +614,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    - -
    -

    void At(int row, int column, Complex32 value)

    -
    - - - -
    @@ -644,6 +636,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    + + +
    +

    void At(int row, int column, Complex32 value)

    +
    + + + +
    @@ -724,8 +725,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(Func<Complex32, bool> zeroPredicate)

    -
    Set all values that meet the predicate to zero, in-place. +

    void CoerceZero(double threshold)

    +
    Set all values whose absolute value is smaller than the threshold to zero. @@ -733,8 +734,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(double threshold)

    -
    Set all values whose absolute value is smaller than the threshold to zero. +

    void CoerceZero(Func<Complex32, bool> zeroPredicate)

    +
    Set all values that meet the predicate to zero, in-place. @@ -742,8 +743,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. +

    void Column(int index, Vector<T> result)

    +
    Copies a column into to the given Vector.
    @@ -751,19 +752,16 @@ Use ToRowMajorArray instead if you always need an independent array.
    int index

    The column to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    -

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    -
    Copies the requested column elements into a new Vector. +

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    +
    Copies the requested column elements into the given vector.
    @@ -775,51 +773,54 @@ Use ToRowMajorArray instead if you always need an independent array.

    The row to start copying from.

    int length

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the requested elements.

    -
    -

    void Column(int index, Vector<T> result)

    -
    Copies a column into to the given Vector. +

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    +
    Copies the requested column elements into a new Vector.
    Parameters
    -
    int index
    -

    The column to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int columnIndex
    +

    The column to copy elements from.

    +
    int rowIndex
    +

    The row to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the requested elements.

    +
    -

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    -
    Copies the requested column elements into the given vector. +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>.
    Parameters
    -
    int columnIndex
    -

    The column to copy elements from.

    -
    int rowIndex
    -

    The row to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The column to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    @@ -865,21 +866,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The condition number of the matrix.

    -
    -
    -
    -

    void Conjugate(Matrix<T> result)

    -
    Complex conjugate each element of this matrix and place the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The result of the conjugation.

    -
    - -
    @@ -896,11 +882,17 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. +
    +

    void Conjugate(Matrix<T> result)

    +
    Complex conjugate each element of this matrix and place the results into the result matrix. + +
    +
    Parameters
    +
    Matrix<T> result
    +

    The result of the conjugation.

    +
    @@ -919,23 +911,12 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result. - +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -956,26 +937,9 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +
    +

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result.
    @@ -1028,6 +992,43 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + + +
    +
    +
    +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    +
    @@ -1622,7 +1623,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1632,18 +1633,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1653,10 +1651,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -1789,8 +1790,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -1798,8 +1799,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -1913,34 +1914,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Complex32 scalar, Matrix<T> result)

    -
    - - - - -
    -
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    Vector<T> Multiply(Vector<T> rightSide)

    +
    Multiplies this matrix by a vector and returns the result.
    @@ -1948,36 +1923,39 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Vector<T> rightSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> Multiply(Vector<T> rightSide)

    -
    Multiplies this matrix by a vector and returns the result. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    Return
    -
    Vector<T>
    +
    Matrix<T>

    The result of the multiplication.

    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix.
    @@ -1985,13 +1963,10 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2004,17 +1979,29 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +
    +

    void Multiply(Complex32 scalar, Matrix<T> result)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    + +
    +
    +
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2031,6 +2018,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2119,15 +2120,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMaximum(Complex32 scalar)

    -
    - - - -
    @@ -2169,6 +2161,24 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAbsoluteMaximum(Complex32 scalar)

    +
    + + + + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(Complex32 scalar, Matrix<T> result)

    +
    + + + +
    @@ -2187,7 +2197,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Complex32 scalar)

    @@ -2210,15 +2220,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    - -
    -

    Matrix<T> PointwiseAbsoluteMinimum(Complex32 scalar)

    -
    - - - -
    @@ -2294,31 +2295,31 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The other matrix 'y'

    -
    Matrix<T> result
    -

    The matrix with the result and 'x'

    -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The other matrix 'y'

    +
    Matrix<T> result
    +

    The matrix with the result and 'x'

    +
    @@ -2348,34 +2349,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCos(Matrix<T> result)

    +

    Matrix<T> PointwiseCos()

    Pointwise applies the cos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCos()

    +

    void PointwiseCos(Matrix<T> result)

    Pointwise applies the cos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseCosh()

    -
    Pointwise applies the cosh function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2393,6 +2385,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    + + +
    +

    Matrix<T> PointwiseCosh()

    +
    Pointwise applies the cosh function to each value + + + +
    @@ -2454,6 +2455,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    + +
    +

    Matrix<T> PointwiseFloor()

    +
    Pointwise applies the floor function to each value + + + +
    @@ -2471,9 +2481,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseFloor()

    -
    Pointwise applies the floor function to each value +
    +

    Matrix<T> PointwiseLog()

    +
    Pointwise applies the natural logarithm function to each value. @@ -2495,9 +2505,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseLog()

    -
    Pointwise applies the natural logarithm function to each value. +
    +

    Matrix<T> PointwiseLog10()

    +
    Pointwise applies the log10 function to each value @@ -2517,19 +2527,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    Matrix<T> PointwiseLog10()

    -
    Pointwise applies the log10 function to each value - - - -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2538,6 +2539,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -2562,7 +2565,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2571,8 +2574,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2750,9 +2751,9 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    +

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix and stores the result into the result matrix. +of this matrix by another matrix.
    @@ -2760,17 +2761,15 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise remainder.

    -

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    +

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix. +of this matrix by another matrix and stores the result into the result matrix.
    @@ -2778,6 +2777,8 @@ of this matrix by another matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise remainder.

    @@ -3117,6 +3118,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3305,10 +3329,22 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Complex32[] row)

    -
    +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row. +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> row
    +

    The vector to copy the values from.

    +
    @@ -3331,22 +3367,10 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Complex32[] row)

    +
    -
    -
    Parameters
    - -
    int rowIndex
    -

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> row
    -

    The vector to copy the values from.

    -
    @@ -3421,27 +3445,27 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    Matrix<T> Solve(Matrix<T> input)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Vector<T> input
    -

    The right hand side vector, .

    +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    +
    Matrix<T>
    +

    The left hand side Matrix`1 , .

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3450,24 +3474,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    -

    void Solve(Matrix<T> input, Matrix<T> result)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    +
    Vector<T> input
    +

    The right hand side vector, .

    +
    Vector<T> result

    The left hand side Matrix`1 , .

    @@ -3475,7 +3502,7 @@ Min(Rows, Columns).

    -

    Matrix<T> Solve(Matrix<T> input)

    +

    void Solve(Matrix<T> input, Matrix<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3484,18 +3511,15 @@ Min(Rows, Columns).

    Matrix<T> input

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Matrix<T>
    -

    The left hand side Matrix`1 , .

    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3530,33 +3554,16 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Matrix<T> input
    -

    The solution matrix B.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result matrix X.

    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -3565,7 +3572,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3574,11 +3581,28 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result matrix X.

    +
    @@ -3620,32 +3644,32 @@ Min(Rows, Columns).

    -

    void StrictlyLowerTriangle(Matrix<T> result)

    -
    Puts the strictly lower triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyLowerTriangle()

    +
    Returns a new matrix containing the lower triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The lower triangle of this matrix.

    -
    -

    Matrix<T> StrictlyLowerTriangle()

    -
    Returns a new matrix containing the lower triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyLowerTriangle(Matrix<T> result)

    +
    Puts the strictly lower triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The lower triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -3706,18 +3730,10 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - +

    void Subtract(Complex32 scalar, Matrix<T> result)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    @@ -3743,10 +3759,18 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(Complex32 scalar, Matrix<T> result)

    -
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    @@ -3761,7 +3785,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(Complex32 scalar)

    +

    void SubtractFrom(Complex32 scalar, Matrix<T> result)

    @@ -3770,7 +3794,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(Complex32 scalar)

    @@ -3831,8 +3855,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -3840,8 +3864,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    +
    @@ -3849,7 +3873,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<Complex32, string> formatValue)

    @@ -3867,7 +3891,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3876,7 +3900,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<Complex32, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3923,9 +3947,8 @@ The format string is ignored.
    -

    string ToString()

    -
    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    +
    Returns a string that summarizes this matrix. @@ -3933,8 +3956,9 @@ The maximum number of cells can be configured in the -

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    -
    Returns a string that summarizes this matrix. +

    string ToString()

    +
    Returns a string that summarizes this matrix. +The maximum number of cells can be configured in the Control class. @@ -3988,8 +4012,8 @@ The maximum number of cells can be configured in the -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix.
    @@ -3997,19 +4021,16 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix. +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result.
    @@ -4017,16 +4038,19 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4034,13 +4058,10 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -4082,8 +4103,8 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4091,8 +4112,34 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    + +
    +
    +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. + + +
    +
    Parameters
    + +
    Vector<T> input
    +

    The solution vector b.

    +
    Vector<T> result
    +

    The result vector x.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    @@ -4155,29 +4202,6 @@ The maximum number of cells can be configured in the -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - -
    -
    Parameters
    - -
    Vector<T> input
    -

    The solution vector b.

    -
    Vector<T> result
    -

    The result vector x.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseMatrix.htm index f943079f..b87b62e9 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseMatrix.htm @@ -402,6 +402,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -496,8 +497,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..

    SparseMatrix(int rows, int columns)

    Create a new sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -519,8 +519,7 @@ storage for performance or interop reasons.

    SparseMatrix(int order)

    Create a new square sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -661,7 +660,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalArray(Complex32[] diagonal)

    +

    SparseMatrix OfDiagonalArray(int rows, int columns, Complex32[] diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -672,7 +671,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalArray(int rows, int columns, Complex32[] diagonal)

    +

    SparseMatrix OfDiagonalArray(Complex32[] diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -1631,18 +1630,6 @@ The enumerator will include all values, even if they are zero. -
    -
    -
    -

    IEnumerable<Tuple<int, Vector<Complex32>>> EnumerateRowsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the row index -and the second value being the value of the row at that index. -
    - - - -
    @@ -1663,6 +1650,18 @@ and the second value being the value of the row at that index.
    +
    +
    +
    +

    IEnumerable<Tuple<int, Vector<Complex32>>> EnumerateRowsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the row index +and the second value being the value of the row at that index. +
    + + + +
    @@ -2031,8 +2030,8 @@ In a later release, it will be replaced with a sparse implementation.
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -2040,19 +2039,16 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -2060,10 +2056,13 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    @@ -2128,8 +2127,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -2137,8 +2136,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<Complex32, Complex32, Complex32> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -2272,16 +2271,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -2318,16 +2317,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result

    The result of the multiplication.

    @@ -2344,31 +2343,31 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Negate(Matrix<T> result)

    -
    Negate each element of this matrix and place the results into the result matrix. +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    The result of the negation.

    +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +

    void Negate(Matrix<T> result)

    +
    Negate each element of this matrix and place the results into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    +
    Matrix<T> result
    +

    The result of the negation.

    +
    @@ -2461,10 +2460,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(Complex32 scalar)

    -
    +

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    +
    Pointwise applies the absolute maximum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2496,22 +2501,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    -
    Pointwise applies the absolute maximum with the values of another matrix to each value. - +

    Matrix<T> PointwiseAbsoluteMaximum(Complex32 scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2520,15 +2519,13 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -

    void PointwiseAbsoluteMinimum(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Complex32 scalar)

    @@ -2537,7 +2534,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(Complex32 scalar)

    +

    void PointwiseAbsoluteMinimum(Complex32 scalar, Matrix<T> result)

    @@ -2546,7 +2543,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2555,40 +2552,33 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseAcos(Matrix<T> result)

    +

    Matrix<T> PointwiseAcos()

    Pointwise applies the acos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAcos()

    +

    void PointwiseAcos(Matrix<T> result)

    Pointwise applies the acos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseAsin()

    -
    Pointwise applies the asin function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2606,6 +2596,15 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAsin()

    +
    Pointwise applies the asin function to each value + + + +
    @@ -2711,32 +2710,32 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCosh(Matrix<T> result)

    +

    Matrix<T> PointwiseCosh()

    Pointwise applies the cosh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCosh()

    +

    void PointwiseCosh(Matrix<T> result)

    Pointwise applies the cosh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    -
    Pointwise divide this matrix by another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    +
    Pointwise divide this matrix by another matrix.
    @@ -2744,16 +2743,19 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise division.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise division of this matrix and divisor.

    +
    -

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    -
    Pointwise divide this matrix by another matrix. +

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    +
    Pointwise divide this matrix by another matrix and stores the result into the result matrix.
    @@ -2761,13 +2763,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise division.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise division of this matrix and divisor.

    -
    @@ -2796,25 +2795,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseFloor(Matrix<T> result)

    +

    Matrix<T> PointwiseFloor()

    Pointwise applies the floor function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseFloor()

    +

    void PointwiseFloor(Matrix<T> result)

    Pointwise applies the floor function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2844,25 +2843,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2880,15 +2879,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    void PointwiseMaximum(Complex32 scalar, Matrix<T> result)

    -
    - - - -
    @@ -2906,6 +2896,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    void PointwiseMaximum(Complex32 scalar, Matrix<T> result)

    +
    + + + +
    @@ -2950,7 +2949,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(Complex32 scalar)

    +

    void PointwiseMinimum(Complex32 scalar, Matrix<T> result)

    @@ -2959,7 +2958,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Complex32 scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMinimum(Complex32 scalar)

    @@ -3039,7 +3038,7 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(Complex32 exponent)

    +

    void PointwisePower(Complex32 exponent, Matrix<T> result)

    @@ -3048,32 +3047,34 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(Matrix<T> exponent)

    -
    Pointwise raise this matrix to an exponent and store the result into the result matrix. - +

    Matrix<T> PointwisePower(Complex32 exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    -

    void PointwisePower(Complex32 exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. +
    +
    Parameters
    + +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(Matrix<T> exponent)

    +
    Pointwise raise this matrix to an exponent and store the result into the result matrix.
    @@ -3081,8 +3082,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> exponent

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    @@ -3456,6 +3455,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3566,23 +3588,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Vector<T> column)

    -
    Copies the values of the given Vector to the specified column. - - -
    -
    Parameters
    - -
    int columnIndex
    -

    The column to copy the values to.

    -
    Vector<T> column
    -

    The vector to copy the values from.

    -
    - -
    @@ -3613,6 +3618,23 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Vector<T> column)

    +
    Copies the values of the given Vector to the specified column. + + +
    +
    Parameters
    + +
    int columnIndex
    +

    The column to copy the values to.

    +
    Vector<T> column
    +

    The vector to copy the values from.

    +
    + +
    @@ -3641,6 +3663,15 @@ Min(Rows, Columns).

    +
    +
    +
    +

    void SetRow(int rowIndex, Complex32[] row)

    +
    + + + +
    @@ -3679,19 +3710,10 @@ Min(Rows, Columns).

    -
    -
    -
    -

    void SetRow(int rowIndex, Complex32[] row)

    -
    - - - -
    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3700,8 +3722,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3733,7 +3763,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3742,16 +3772,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3760,24 +3782,7 @@ Min(Rows, Columns).

    -

    void Solve(Matrix<T> input, Matrix<T> result)

    -
    Solves a system of linear equations, , with A QR factorized. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    -

    The left hand side Matrix`1 , .

    -
    - - -
    -
    -
    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3786,10 +3791,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3814,7 +3822,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3823,13 +3831,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    + +
    +
    +
    +

    void Solve(Matrix<T> input, Matrix<T> result)

    +
    Solves a system of linear equations, , with A QR factorized. + + +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    +
    @@ -3904,7 +3926,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3913,7 +3935,7 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3922,7 +3944,7 @@ Min(Rows, Columns).

    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3931,15 +3953,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3948,13 +3973,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -4045,7 +4067,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Matrix<T> other)

    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    Subtracts another matrix from this matrix. @@ -4054,13 +4076,10 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the subtraction.

    -
    @@ -4074,16 +4093,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Complex32 scalar)

    -
    - - - - -
    -
    -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Subtract(Matrix<T> other)

    Subtracts another matrix from this matrix. @@ -4092,15 +4102,18 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the subtraction.

    +
    -
    -

    void SubtractFrom(Complex32 scalar, Matrix<T> result)

    +
    +

    Matrix<T> Subtract(Complex32 scalar)

    @@ -4115,6 +4128,15 @@ does not contain the diagonal elements of this matrix. +
    +
    +
    +

    void SubtractFrom(Complex32 scalar, Matrix<T> result)

    +
    + + + +
    @@ -4188,7 +4210,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4197,7 +4219,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +

    string ToMatrixString(string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4260,9 +4282,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4270,10 +4293,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4301,6 +4323,15 @@ The format string is ignored.

    The trace of this matrix

    +
    +
    +
    +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4317,12 +4348,23 @@ The format string is ignored.
    -
    -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. +
    +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4343,9 +4385,9 @@ The format string is ignored.
    -
    -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4353,19 +4395,16 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. +

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the transpose of this matrix with a vector and places the results into the result vector.
    @@ -4373,56 +4412,36 @@ The format string is ignored.
    Vector<T> rightSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    Return
    -
    Matrix<T>
    +
    Vector<T>

    The result of the multiplication.

    -

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4430,10 +4449,13 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4484,7 +4506,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4493,7 +4515,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4502,7 +4524,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4511,7 +4533,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4584,7 +4606,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseVector.htm index b4dcf4c1..811fc873 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/SparseVector.htm @@ -362,8 +362,7 @@

    SparseVector(int length)

    Create a new sparse vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2605,7 +2604,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/Vector.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/Vector.htm index 487f0f39..c88a7840 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/Vector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/Vector.htm @@ -2458,7 +2458,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Complex32/index.htm b/api/MathNet.Numerics.LinearAlgebra.Complex32/index.htm index a0585c66..1791b537 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Complex32/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Complex32/index.htm @@ -167,7 +167,7 @@
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/BiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/BiCgStab.htm index b0a96621..9f6cde3e 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/BiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/BiCgStab.htm @@ -271,7 +271,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/CompositeSolver.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/CompositeSolver.htm index 750d26db..4a2a2350 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/CompositeSolver.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/CompositeSolver.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/DiagonalPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/DiagonalPreconditioner.htm index 33e9cbd3..904eac2d 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/DiagonalPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/DiagonalPreconditioner.htm @@ -272,7 +272,7 @@ of the matrix diagonal as preconditioning values. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/GpBiCg.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/GpBiCg.htm index 32968780..78c57113 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/GpBiCg.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/GpBiCg.htm @@ -291,7 +291,7 @@ before switching over to the BiCgStab algorithm. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILU0Preconditioner.htm index 51f71704..80388f18 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILU0Preconditioner.htm @@ -273,7 +273,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILUTPPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILUTPPreconditioner.htm index e3b76814..40789e64 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILUTPPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/ILUTPPreconditioner.htm @@ -384,7 +384,7 @@ the preconditioner.

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MILU0Preconditioner.htm index efb2f474..00ee7884 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MILU0Preconditioner.htm @@ -298,7 +298,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MlkBiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MlkBiCgStab.htm index d9764590..4efb63dc 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MlkBiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/MlkBiCgStab.htm @@ -299,7 +299,7 @@ Krylov sub-space. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/TFQMR.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/TFQMR.htm index d1f842e6..11284f64 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/TFQMR.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/TFQMR.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm index 480cca5c..16a8a80a 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm @@ -175,7 +175,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/DenseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Double/DenseMatrix.htm index 3af011b1..f6a4f73d 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/DenseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/DenseMatrix.htm @@ -402,6 +402,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -507,8 +508,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    DenseMatrix(int rows, int columns)

    Create a new dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -516,11 +516,9 @@ Zero-length matrices are not supported.
    -

    DenseMatrix(DenseColumnMajorMatrixStorage<T> storage)

    -
    Create a new dense matrix straight from an initialized matrix storage instance. -The storage is used directly without copying. -Intended for advanced scenarios where you're working directly with -storage for performance or interop reasons. +

    DenseMatrix(int order)

    +
    Create a new square dense matrix with the given number of rows and columns. +All cells of the matrix will be initialized to zero. @@ -528,10 +526,11 @@ storage for performance or interop reasons.
    -

    DenseMatrix(int order)

    -
    Create a new square dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +

    DenseMatrix(DenseColumnMajorMatrixStorage<T> storage)

    +
    Create a new dense matrix straight from an initialized matrix storage instance. +The storage is used directly without copying. +Intended for advanced scenarios where you're working directly with +storage for performance or interop reasons. @@ -605,8 +604,10 @@ Zero-length matrices are not supported.
    -

    DenseMatrix OfColumnArrays(Double[][] columns)

    -
    +

    DenseMatrix OfColumnArrays(IEnumerable<Double[]> columns)

    +
    Create a new dense matrix as a copy of the given column arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -614,10 +615,8 @@ Zero-length matrices are not supported.
    -

    DenseMatrix OfColumnArrays(IEnumerable<Double[]> columns)

    -
    Create a new dense matrix as a copy of the given column arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    DenseMatrix OfColumnArrays(Double[][] columns)

    +
    @@ -661,10 +660,8 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumnVectors(IEnumerable<Vector<double>> columns)

    -
    Create a new dense matrix as a copy of the given column vectors. -This new matrix will be independent from the vectors. -A new memory block will be allocated for storing the matrix. +

    DenseMatrix OfColumnVectors(Vector`1[] columns)

    +
    @@ -672,8 +669,10 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumnVectors(Vector`1[] columns)

    -
    +

    DenseMatrix OfColumnVectors(IEnumerable<Vector<double>> columns)

    +
    Create a new dense matrix as a copy of the given column vectors. +This new matrix will be independent from the vectors. +A new memory block will be allocated for storing the matrix. @@ -814,6 +813,15 @@ A new memory block will be allocated for storing the matrix.

    Public Methods

    +
    +

    Matrix<T> Add(double scalar)

    +
    + + + + +
    +

    void Add(double scalar, Matrix<T> result)

    @@ -824,7 +832,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> Add(Matrix<T> other)

    +

    void Add(Matrix<T> other, Matrix<T> result)

    Adds another matrix to this matrix. @@ -833,27 +841,15 @@ A new memory block will be allocated for storing the matrix.
    Matrix<T> other

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the addition.

    -
    - -
    -
    -
    -

    Matrix<T> Add(double scalar)

    -
    - - -
    -

    void Add(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Add(Matrix<T> other)

    Adds another matrix to this matrix. @@ -862,10 +858,13 @@ A new memory block will be allocated for storing the matrix.
    Matrix<T> other

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the addition.

    +
    @@ -969,15 +968,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    -
    -
    -

    void At(int row, int column, double value)

    -
    - - - -
    @@ -1000,6 +990,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    +
    +
    +
    +

    void At(int row, int column, double value)

    +
    + + + +
    @@ -1250,15 +1249,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    A matrix containing the conjugated values.

    -
    - -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. - - - -
    @@ -1275,19 +1265,11 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    @@ -1310,6 +1292,23 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The result of the multiplication.

    +
    +
    +
    +

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -1333,16 +1332,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result

    The result of the multiplication.

    @@ -1370,16 +1369,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -1472,7 +1471,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    Matrix<T> Divide(double scalar)

    +

    void Divide(double scalar, Matrix<T> result)

    @@ -1481,7 +1480,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    void Divide(double scalar, Matrix<T> result)

    +

    Matrix<T> Divide(double scalar)

    @@ -1529,15 +1528,6 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi -
    -
    -
    -

    IEnumerable<Vector<double>> EnumerateColumns()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - -
    @@ -1555,36 +1545,45 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    +
    +
    +
    +

    IEnumerable<Vector<double>> EnumerateColumns()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. + + + +
    -

    IEnumerable<Tuple<int, Vector<double>>> EnumerateColumnsIndexed(int index, int length)

    -
    Returns an IEnumerable that can be used to iterate through a subset of all columns of the matrix and their index.
    +

    IEnumerable<Tuple<int, Vector<double>>> EnumerateColumnsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    The enumerator returns a Tuple with the first value being the column index and the second value being the value of the column at that index.
    -
    -
    Parameters
    - -
    int index
    -

    The column to start enumerating over.

    -
    int length
    -

    The number of columns to enumerating over.

    -
    -

    IEnumerable<Tuple<int, Vector<double>>> EnumerateColumnsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    +

    IEnumerable<Tuple<int, Vector<double>>> EnumerateColumnsIndexed(int index, int length)

    +
    Returns an IEnumerable that can be used to iterate through a subset of all columns of the matrix and their index.
    The enumerator returns a Tuple with the first value being the column index and the second value being the value of the column at that index.
    +
    +
    Parameters
    + +
    int index
    +

    The column to start enumerating over.

    +
    int length
    +

    The number of columns to enumerating over.

    +
    @@ -1978,7 +1977,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1988,18 +1987,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -2009,10 +2005,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -2048,8 +2047,8 @@ In a later release, it will be replaced with a sparse implementation.
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -2057,16 +2056,19 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -2074,13 +2076,10 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    @@ -2233,7 +2232,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Modulus(double divisor, Matrix<T> result)

    +

    Matrix<T> Modulus(double divisor)

    @@ -2242,7 +2241,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Modulus(double divisor)

    +

    void Modulus(double divisor, Matrix<T> result)

    @@ -2289,36 +2288,38 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    void Multiply(double scalar, Matrix<T> result)

    -
    - - - - -
    -
    -
    -

    Matrix<T> Multiply(double scalar)

    -
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2341,22 +2342,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(double scalar, Matrix<T> result)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    + +
    +
    +
    +

    Matrix<T> Multiply(double scalar)

    +
    + + -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2454,25 +2453,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbs(Matrix<T> result)

    +

    Matrix<T> PointwiseAbs()

    Pointwise applies the abs function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAbs()

    +

    void PointwiseAbs(Matrix<T> result)

    Pointwise applies the abs function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2528,18 +2527,19 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the absolute minimum with the values of another matrix to each value. +

    Matrix<T> PointwiseAbsoluteMinimum(double scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(double scalar, Matrix<T> result)

    +
    + +
    @@ -2560,19 +2560,18 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(double scalar, Matrix<T> result)

    -
    - - +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +
    Pointwise applies the absolute minimum with the values of another matrix to each value. - -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMinimum(double scalar)

    -
    +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    @@ -2602,25 +2601,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAsin(Matrix<T> result)

    +

    Matrix<T> PointwiseAsin()

    Pointwise applies the asin function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAsin()

    +

    void PointwiseAsin(Matrix<T> result)

    Pointwise applies the asin function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2647,17 +2646,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    - - -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    -
    Pointwise applies the atan2 function to each value of the current -matrix and a given other matrix being the 'x' of atan2 and the -'this' matrix being the 'y' - - - -
    @@ -2679,9 +2667,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCeiling()

    -
    Pointwise applies the ceiling function to each value +
    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +
    Pointwise applies the atan2 function to each value of the current +matrix and a given other matrix being the 'x' of atan2 and the +'this' matrix being the 'y' @@ -2703,9 +2693,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCos()

    -
    Pointwise applies the cos function to each value +
    +

    Matrix<T> PointwiseCeiling()

    +
    Pointwise applies the ceiling function to each value @@ -2725,6 +2715,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    Matrix<T> PointwiseCos()

    +
    Pointwise applies the cos function to each value + + + +
    @@ -2861,31 +2860,31 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2894,13 +2893,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2909,8 +2910,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2935,18 +2934,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(double scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2961,16 +2952,22 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(double scalar)

    -
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2979,6 +2976,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -3056,24 +3055,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. - +

    Matrix<T> PointwisePower(double exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    -

    Matrix<T> PointwisePower(double exponent)

    +

    void PointwisePower(double exponent, Matrix<T> result)

    @@ -3082,10 +3073,18 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(double exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. +
    +
    Parameters
    + +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -3236,25 +3235,25 @@ of this matrix by another matrix.
    -

    Matrix<T> PointwiseSqrt()

    +

    void PointwiseSqrt(Matrix<T> result)

    Pointwise applies the sqrt function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseSqrt(Matrix<T> result)

    +

    Matrix<T> PointwiseSqrt()

    Pointwise applies the sqrt function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -3284,32 +3283,32 @@ of this matrix by another matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3317,16 +3316,14 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3334,6 +3331,8 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    @@ -3473,6 +3472,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3661,8 +3683,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3670,10 +3692,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3682,8 +3700,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3691,6 +3709,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3851,20 +3873,28 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    +
    +
    Parameters
    +
    Vector<T> input
    +

    The solution vector b.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Vector<T>
    +

    The result vector x.

    +
    @@ -3895,28 +3925,20 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Vector<T> input
    -

    The solution vector b.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + -
    -
    Return
    -
    Vector<T>
    -

    The result vector x.

    -
    @@ -3930,7 +3952,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4006,32 +4028,32 @@ does not contain the diagonal elements of this matrix.
    -

    void StrictlyUpperTriangle(Matrix<T> result)

    -
    Puts the strictly upper triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyUpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> StrictlyUpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyUpperTriangle(Matrix<T> result)

    +
    Puts the strictly upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4059,6 +4081,23 @@ does not contain the diagonal elements of this matrix.

    The requested sub-matrix.

    +
    +
    +
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    + +
    @@ -4097,23 +4136,6 @@ does not contain the diagonal elements of this matrix.

    The result of the subtraction.

    -
    - -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    - -
    @@ -4187,8 +4209,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4205,8 +4227,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    +
    @@ -4214,7 +4236,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4318,15 +4340,6 @@ The maximum number of cells can be configured in the -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. - - - -
    @@ -4341,6 +4354,15 @@ The maximum number of cells can be configured in the +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4378,6 +4400,23 @@ The maximum number of cells can be configured in the +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -4435,23 +4474,6 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -4537,31 +4559,31 @@ The maximum number of cells can be configured in the -

    void UpperTriangle(Matrix<T> result)

    -
    Puts the upper triangle of this matrix into the result matrix. +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +

    void UpperTriangle(Matrix<T> result)

    +
    Puts the upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4601,7 +4623,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/DenseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Double/DenseVector.htm index 4bf3c369..1b89119a 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/DenseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/DenseVector.htm @@ -386,8 +386,7 @@ storage for performance or interop reasons.

    DenseVector(int length)

    Create a new dense vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2637,7 +2636,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/DiagonalMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Double/DiagonalMatrix.htm index 4c5d2aa1..7b6007b5 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/DiagonalMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/DiagonalMatrix.htm @@ -389,6 +389,7 @@ entries are set. The exception to this is when the off diagonal elements are
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -493,8 +494,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    DiagonalMatrix(int order)

    Create a new square diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -504,8 +504,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns)

    Create a new diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -515,8 +514,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns, double diagonalValue)

    Create a new diagonal matrix with the given number of rows and columns. -All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. -Zero-length matrices are not supported. +All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. @@ -1072,8 +1070,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. +

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result.
    @@ -1081,16 +1079,19 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result. +

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix.
    @@ -1098,13 +1099,10 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -1149,16 +1147,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result

    The result of the multiplication.

    @@ -1166,16 +1164,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -1325,15 +1323,6 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi -
    -
    -
    -

    IEnumerable<Vector<double>> EnumerateColumns()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - -
    @@ -1353,12 +1342,9 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    -
    -

    IEnumerable<Tuple<int, Vector<double>>> EnumerateColumnsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the column index -and the second value being the value of the column at that index. -
    +
    +

    IEnumerable<Vector<double>> EnumerateColumns()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. @@ -1383,10 +1369,22 @@ and the second value being the value of the column at that index.
    +
    +
    +
    +

    IEnumerable<Tuple<int, Vector<double>>> EnumerateColumnsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the column index +and the second value being the value of the column at that index. +
    + + + +
    -

    IEnumerable<Tuple<int, int, double>> EnumerateIndexed(Zeros zeros)

    +

    IEnumerable<Tuple<int, int, double>> EnumerateIndexed()

    Returns an IEnumerable that can be used to iterate through all values of the matrix and their index.
    The enumerator returns a Tuple with the first two values being the row and column index and the third value being the value of the element at that index. @@ -1399,7 +1397,7 @@ The enumerator will include all values, even if they are zero.
    -

    IEnumerable<Tuple<int, int, double>> EnumerateIndexed()

    +

    IEnumerable<Tuple<int, int, double>> EnumerateIndexed(Zeros zeros)

    Returns an IEnumerable that can be used to iterate through all values of the matrix and their index.
    The enumerator returns a Tuple with the first two values being the row and column index and the third value being the value of the element at that index. @@ -1841,8 +1839,8 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -1850,16 +1848,19 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -1867,13 +1868,10 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    @@ -2097,23 +2095,6 @@ on the actual data storage implementation (relevant mostly for sparse matrices).

    The result of the multiplication.

    -
    -
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -2153,17 +2134,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +
    +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    @@ -2180,6 +2164,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2634,25 +2632,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog()

    +

    void PointwiseLog(Matrix<T> result)

    Pointwise applies the natural logarithm function to each value. +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    -

    void PointwiseLog(Matrix<T> result)

    +

    Matrix<T> PointwiseLog()

    Pointwise applies the natural logarithm function to each value. -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2679,6 +2677,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    +
    +
    +

    void PointwiseMaximum(double scalar, Matrix<T> result)

    +
    + + + +
    @@ -2714,7 +2721,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(double scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(double scalar)

    @@ -2722,11 +2729,17 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseMaximum(double scalar)

    -
    +
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. + +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2741,24 +2754,16 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(double scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2767,18 +2772,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -
    -
    -
    -

    Matrix<T> PointwiseMinimum(double scalar)

    -
    - - - -
    @@ -2816,8 +2814,8 @@ of this matrix by another matrix.
    -

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    -
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    +
    Pointwise multiplies this matrix with another matrix.
    @@ -2825,16 +2823,19 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise multiplication of this matrix and other.

    +
    -

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    -
    Pointwise multiplies this matrix with another matrix. +

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    +
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix.
    @@ -2842,29 +2843,27 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise multiplication of this matrix and other.

    -
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(double exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    + +
    +
    +
    +

    void PointwisePower(double exponent, Matrix<T> result)

    +
    + +
    @@ -2885,19 +2884,18 @@ of this matrix by another matrix.
    -

    void PointwisePower(double exponent, Matrix<T> result)

    -
    - +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. - -
    -
    -
    -

    Matrix<T> PointwisePower(double exponent)

    -
    - +
    +
    Parameters
    +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -2937,25 +2935,25 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRound(Matrix<T> result)

    +

    Matrix<T> PointwiseRound()

    Pointwise applies the round function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseRound()

    +

    void PointwiseRound(Matrix<T> result)

    Pointwise applies the round function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -3081,32 +3079,32 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3114,14 +3112,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3129,8 +3129,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    @@ -3272,23 +3270,47 @@ also known as the range or image of the corresponding matrix transformation.
    -
    -

    Vector<T> Row(int index)

    -
    Copies a row into an Vector. +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero.
    Parameters
    -
    int index
    -

    The row to copy.

    +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    + +
    +
    +
    +

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    +
    Copies the requested row elements into a new Vector. + + +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy elements from.

    +
    int columnIndex
    +

    The column to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    +
    @@ -3334,23 +3356,22 @@ also known as the range or image of the corresponding matrix transformation.
    -

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    -
    Copies the requested row elements into a new Vector. +

    Vector<T> Row(int index)

    +
    Copies a row into an Vector.
    Parameters
    -
    int rowIndex
    -

    The row to copy elements from.

    -
    int columnIndex
    -

    The column to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The row to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    @@ -3380,15 +3401,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Double[] column)

    -
    - - - -
    @@ -3427,11 +3439,20 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Double[] column)

    +
    + + + +
    -

    void SetDiagonal(Double[] source)

    -
    Copies the values of the given array to the diagonal.
    +

    void SetDiagonal(Vector<T> source)

    +
    Copies the values of the given Vector<T> to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3440,8 +3461,8 @@ this[i,i].
    Parameters
    -
    Double[] source
    -

    The array to copy the values from. The length of the vector should be +

    Vector<T> source
    +

    The vector to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3449,8 +3470,8 @@ Min(Rows, Columns).

    -

    void SetDiagonal(Vector<T> source)

    -
    Copies the values of the given Vector<T> to the diagonal.
    +

    void SetDiagonal(Double[] source)

    +
    Copies the values of the given array to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3459,8 +3480,8 @@ this[i,i].
    Parameters
    -
    Vector<T> source
    -

    The vector to copy the values from. The length of the vector should be +

    Double[] source
    +

    The array to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3477,8 +3498,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3486,10 +3507,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3498,8 +3515,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3507,6 +3524,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3515,7 +3536,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3524,16 +3545,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3565,7 +3578,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3574,8 +3587,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3584,7 +3605,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3593,13 +3614,10 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    -
    @@ -3624,7 +3642,7 @@ Min(Rows, Columns).

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3633,10 +3651,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3655,6 +3676,24 @@ Min(Rows, Columns).

    +
    +
    +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    @@ -3681,42 +3720,6 @@ Min(Rows, Columns).

    The result matrix X.

    -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - -
    @@ -3743,10 +3746,28 @@ Min(Rows, Columns).

    The result vector x.

    +
    + +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3755,15 +3776,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3772,13 +3796,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -3924,7 +3945,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(double scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(double scalar)

    @@ -3933,7 +3954,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(double scalar)

    +

    void SubtractFrom(double scalar, Matrix<T> result)

    @@ -3994,8 +4015,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4003,8 +4024,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4012,8 +4033,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    +
    @@ -4021,8 +4042,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    +
    @@ -4030,7 +4051,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4039,7 +4060,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4075,9 +4096,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4085,10 +4107,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4185,6 +4206,26 @@ The format string is ignored.
    +
    +
    +
    +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    +
    @@ -4239,49 +4280,6 @@ The format string is ignored.
    -
    -
    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    - -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    - -
    -
    -
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The solution matrix B.

    -
    Matrix<T> result
    -

    The result matrix X

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    @@ -4294,7 +4292,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4303,7 +4301,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4312,10 +4310,24 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    Matrix<T> result
    +

    The result matrix X

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    @@ -4343,17 +4355,12 @@ The format string is ignored.
    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    -
    @@ -4370,6 +4377,20 @@ The format string is ignored.
    +
    +
    +
    +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    +
    +
    @@ -4400,7 +4421,7 @@ The format string is ignored. diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/Matrix.htm b/api/MathNet.Numerics.LinearAlgebra.Double/Matrix.htm index dd9a2bd7..ac610cd7 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/Matrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/Matrix.htm @@ -366,6 +366,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -459,7 +460,7 @@

    Public Methods

    -

    void Add(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Add(Matrix<T> other)

    Adds another matrix to this matrix. @@ -468,30 +469,22 @@
    Matrix<T> other

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the addition.

    +
    -

    Matrix<T> Add(Matrix<T> other)

    -
    Adds another matrix to this matrix. - +

    Matrix<T> Add(double scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to add to this matrix.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the addition.

    -
    @@ -505,10 +498,18 @@
    -

    Matrix<T> Add(double scalar)

    -
    +

    void Add(Matrix<T> other, Matrix<T> result)

    +
    Adds another matrix to this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    +
    @@ -613,15 +614,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    - -
    -

    void At(int row, int column, double value)

    -
    - - - -
    @@ -644,6 +636,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    + + +
    +

    void At(int row, int column, double value)

    +
    + + + +
    @@ -724,8 +725,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(Func<double, bool> zeroPredicate)

    -
    Set all values that meet the predicate to zero, in-place. +

    void CoerceZero(double threshold)

    +
    Set all values whose absolute value is smaller than the threshold to zero. @@ -733,8 +734,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(double threshold)

    -
    Set all values whose absolute value is smaller than the threshold to zero. +

    void CoerceZero(Func<double, bool> zeroPredicate)

    +
    Set all values that meet the predicate to zero, in-place. @@ -742,8 +743,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. +

    void Column(int index, Vector<T> result)

    +
    Copies a column into to the given Vector.
    @@ -751,19 +752,16 @@ Use ToRowMajorArray instead if you always need an independent array.
    int index

    The column to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    -

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    -
    Copies the requested column elements into a new Vector. +

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    +
    Copies the requested column elements into the given vector.
    @@ -775,51 +773,54 @@ Use ToRowMajorArray instead if you always need an independent array.

    The row to start copying from.

    int length

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the requested elements.

    -
    -

    void Column(int index, Vector<T> result)

    -
    Copies a column into to the given Vector. +

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    +
    Copies the requested column elements into a new Vector.
    Parameters
    -
    int index
    -

    The column to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int columnIndex
    +

    The column to copy elements from.

    +
    int rowIndex
    +

    The row to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the requested elements.

    +
    -

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    -
    Copies the requested column elements into the given vector. +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>.
    Parameters
    -
    int columnIndex
    -

    The column to copy elements from.

    -
    int rowIndex
    -

    The row to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The column to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    @@ -865,21 +866,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The condition number of the matrix.

    -
    -
    -
    -

    void Conjugate(Matrix<T> result)

    -
    Complex conjugate each element of this matrix and place the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The result of the conjugation.

    -
    - -
    @@ -896,11 +882,17 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. +
    +

    void Conjugate(Matrix<T> result)

    +
    Complex conjugate each element of this matrix and place the results into the result matrix. + +
    +
    Parameters
    +
    Matrix<T> result
    +

    The result of the conjugation.

    +
    @@ -919,23 +911,12 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result. - +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -956,26 +937,9 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +
    +

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result.
    @@ -1028,6 +992,43 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + + +
    +
    +
    +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    +
    @@ -1622,7 +1623,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1632,18 +1633,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1653,10 +1651,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -1789,8 +1790,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<double, double, double> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<double, double, double> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -1798,8 +1799,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<double, double, double> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<double, double, double> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -1913,34 +1914,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(double scalar, Matrix<T> result)

    -
    - - - - -
    -
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    Vector<T> Multiply(Vector<T> rightSide)

    +
    Multiplies this matrix by a vector and returns the result.
    @@ -1948,36 +1923,39 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Vector<T> rightSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> Multiply(Vector<T> rightSide)

    -
    Multiplies this matrix by a vector and returns the result. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    Return
    -
    Vector<T>
    +
    Matrix<T>

    The result of the multiplication.

    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix.
    @@ -1985,13 +1963,10 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2004,17 +1979,29 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +
    +

    void Multiply(double scalar, Matrix<T> result)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    + +
    +
    +
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2031,6 +2018,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2119,15 +2120,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMaximum(double scalar)

    -
    - - - -
    @@ -2169,6 +2161,24 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAbsoluteMaximum(double scalar)

    +
    + + + + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(double scalar, Matrix<T> result)

    +
    + + + +
    @@ -2187,7 +2197,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(double scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(double scalar)

    @@ -2210,15 +2220,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    - -
    -

    Matrix<T> PointwiseAbsoluteMinimum(double scalar)

    -
    - - - -
    @@ -2294,31 +2295,31 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The other matrix 'y'

    -
    Matrix<T> result
    -

    The matrix with the result and 'x'

    -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The other matrix 'y'

    +
    Matrix<T> result
    +

    The matrix with the result and 'x'

    +
    @@ -2348,34 +2349,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCos(Matrix<T> result)

    +

    Matrix<T> PointwiseCos()

    Pointwise applies the cos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCos()

    +

    void PointwiseCos(Matrix<T> result)

    Pointwise applies the cos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseCosh()

    -
    Pointwise applies the cosh function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2393,6 +2385,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    + + +
    +

    Matrix<T> PointwiseCosh()

    +
    Pointwise applies the cosh function to each value + + + +
    @@ -2454,6 +2455,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    + +
    +

    Matrix<T> PointwiseFloor()

    +
    Pointwise applies the floor function to each value + + + +
    @@ -2471,9 +2481,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseFloor()

    -
    Pointwise applies the floor function to each value +
    +

    Matrix<T> PointwiseLog()

    +
    Pointwise applies the natural logarithm function to each value. @@ -2495,9 +2505,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseLog()

    -
    Pointwise applies the natural logarithm function to each value. +
    +

    Matrix<T> PointwiseLog10()

    +
    Pointwise applies the log10 function to each value @@ -2517,19 +2527,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    Matrix<T> PointwiseLog10()

    -
    Pointwise applies the log10 function to each value - - - -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2538,6 +2539,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -2562,7 +2565,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2571,8 +2574,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2750,9 +2751,9 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    +

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix and stores the result into the result matrix. +of this matrix by another matrix.
    @@ -2760,17 +2761,15 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise remainder.

    -

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    +

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix. +of this matrix by another matrix and stores the result into the result matrix.
    @@ -2778,6 +2777,8 @@ of this matrix by another matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise remainder.

    @@ -3117,6 +3118,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3305,10 +3329,22 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Double[] row)

    -
    +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row. +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> row
    +

    The vector to copy the values from.

    +
    @@ -3331,22 +3367,10 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Double[] row)

    +
    -
    -
    Parameters
    - -
    int rowIndex
    -

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> row
    -

    The vector to copy the values from.

    -
    @@ -3421,27 +3445,27 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    Matrix<T> Solve(Matrix<T> input)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Vector<T> input
    -

    The right hand side vector, .

    +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    +
    Matrix<T>
    +

    The left hand side Matrix`1 , .

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3450,24 +3474,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    -

    void Solve(Matrix<T> input, Matrix<T> result)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    +
    Vector<T> input
    +

    The right hand side vector, .

    +
    Vector<T> result

    The left hand side Matrix`1 , .

    @@ -3475,7 +3502,7 @@ Min(Rows, Columns).

    -

    Matrix<T> Solve(Matrix<T> input)

    +

    void Solve(Matrix<T> input, Matrix<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3484,18 +3511,15 @@ Min(Rows, Columns).

    Matrix<T> input

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Matrix<T>
    -

    The left hand side Matrix`1 , .

    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3530,33 +3554,16 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Matrix<T> input
    -

    The solution matrix B.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result matrix X.

    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -3565,7 +3572,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3574,11 +3581,28 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result matrix X.

    +
    @@ -3620,32 +3644,32 @@ Min(Rows, Columns).

    -

    void StrictlyLowerTriangle(Matrix<T> result)

    -
    Puts the strictly lower triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyLowerTriangle()

    +
    Returns a new matrix containing the lower triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The lower triangle of this matrix.

    -
    -

    Matrix<T> StrictlyLowerTriangle()

    -
    Returns a new matrix containing the lower triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyLowerTriangle(Matrix<T> result)

    +
    Puts the strictly lower triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The lower triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -3706,18 +3730,10 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - +

    void Subtract(double scalar, Matrix<T> result)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    @@ -3743,10 +3759,18 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(double scalar, Matrix<T> result)

    -
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    @@ -3761,7 +3785,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(double scalar)

    +

    void SubtractFrom(double scalar, Matrix<T> result)

    @@ -3770,7 +3794,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(double scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(double scalar)

    @@ -3831,8 +3855,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -3840,8 +3864,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    +
    @@ -3849,7 +3873,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<double, string> formatValue)

    @@ -3867,7 +3891,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3876,7 +3900,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<double, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3923,9 +3947,8 @@ The format string is ignored.
    -

    string ToString()

    -
    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    +
    Returns a string that summarizes this matrix. @@ -3933,8 +3956,9 @@ The maximum number of cells can be configured in the -

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    -
    Returns a string that summarizes this matrix. +

    string ToString()

    +
    Returns a string that summarizes this matrix. +The maximum number of cells can be configured in the Control class. @@ -3988,8 +4012,8 @@ The maximum number of cells can be configured in the -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix.
    @@ -3997,19 +4021,16 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix. +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result.
    @@ -4017,16 +4038,19 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4034,13 +4058,10 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -4082,8 +4103,8 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4091,8 +4112,34 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    + +
    +
    +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. + + +
    +
    Parameters
    + +
    Vector<T> input
    +

    The solution vector b.

    +
    Vector<T> result
    +

    The result vector x.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    @@ -4155,29 +4202,6 @@ The maximum number of cells can be configured in the -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - -
    -
    Parameters
    - -
    Vector<T> input
    -

    The solution vector b.

    -
    Vector<T> result
    -

    The result vector x.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/SparseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Double/SparseMatrix.htm index b462aa6f..60a1ae47 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/SparseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/SparseMatrix.htm @@ -402,6 +402,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -496,8 +497,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..

    SparseMatrix(int rows, int columns)

    Create a new sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -519,8 +519,7 @@ storage for performance or interop reasons.

    SparseMatrix(int order)

    Create a new square sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -641,10 +640,8 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfColumnVectors(IEnumerable<Vector<double>> columns)

    -
    Create a new sparse matrix as a copy of the given column vectors. -This new matrix will be independent from the vectors. -A new memory block will be allocated for storing the matrix. +

    SparseMatrix OfColumnVectors(Vector`1[] columns)

    +
    @@ -652,8 +649,10 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfColumnVectors(Vector`1[] columns)

    -
    +

    SparseMatrix OfColumnVectors(IEnumerable<Vector<double>> columns)

    +
    Create a new sparse matrix as a copy of the given column vectors. +This new matrix will be independent from the vectors. +A new memory block will be allocated for storing the matrix. @@ -683,7 +682,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalVector(int rows, int columns, Vector<T> diagonal)

    +

    SparseMatrix OfDiagonalVector(Vector<T> diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -694,7 +693,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalVector(Vector<T> diagonal)

    +

    SparseMatrix OfDiagonalVector(int rows, int columns, Vector<T> diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -2028,23 +2027,6 @@ In a later release, it will be replaced with a sparse implementation.

    The largest singular value of the matrix.

    -
    -
    -
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. - - -
    -
    Parameters
    - -
    Vector<T> leftSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -2067,16 +2049,18 @@ In a later release, it will be replaced with a sparse implementation.
    -
    -

    void LowerTriangle(Matrix<T> result)

    -
    Puts the lower triangle of this matrix into the result matrix. +
    +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    Vector<T> leftSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    @@ -2094,6 +2078,21 @@ In a later release, it will be replaced with a sparse implementation.

    The lower triangle of this matrix.

    +
    +
    +
    +

    void LowerTriangle(Matrix<T> result)

    +
    Puts the lower triangle of this matrix into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    + +
    @@ -2261,10 +2260,38 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Multiply(double scalar)

    -
    +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    + +
    +
    +
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2290,18 +2317,10 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. - +

    Matrix<T> Multiply(double scalar)

    +
    -
    -
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    @@ -2323,22 +2342,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. - +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Return
    Matrix<T>
    -

    The result of the multiplication.

    +

    A matrix containing the negated values.

    @@ -2356,20 +2369,6 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. - - - -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    -
    -
    @@ -2461,10 +2460,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(double scalar)

    -
    +

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    +
    Pointwise applies the absolute maximum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2496,22 +2501,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    -
    Pointwise applies the absolute maximum with the values of another matrix to each value. - +

    Matrix<T> PointwiseAbsoluteMaximum(double scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2520,15 +2519,13 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -

    void PointwiseAbsoluteMinimum(double scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(double scalar)

    @@ -2537,7 +2534,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(double scalar)

    +

    void PointwiseAbsoluteMinimum(double scalar, Matrix<T> result)

    @@ -2546,7 +2543,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2555,40 +2552,33 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseAcos(Matrix<T> result)

    +

    Matrix<T> PointwiseAcos()

    Pointwise applies the acos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAcos()

    +

    void PointwiseAcos(Matrix<T> result)

    Pointwise applies the acos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseAsin()

    -
    Pointwise applies the asin function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2606,6 +2596,15 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAsin()

    +
    Pointwise applies the asin function to each value + + + +
    @@ -2711,32 +2710,32 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCosh(Matrix<T> result)

    +

    Matrix<T> PointwiseCosh()

    Pointwise applies the cosh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCosh()

    +

    void PointwiseCosh(Matrix<T> result)

    Pointwise applies the cosh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    -
    Pointwise divide this matrix by another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    +
    Pointwise divide this matrix by another matrix.
    @@ -2744,16 +2743,19 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise division.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise division of this matrix and divisor.

    +
    -

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    -
    Pointwise divide this matrix by another matrix. +

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    +
    Pointwise divide this matrix by another matrix and stores the result into the result matrix.
    @@ -2761,13 +2763,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise division.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise division of this matrix and divisor.

    -
    @@ -2796,25 +2795,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseFloor(Matrix<T> result)

    +

    Matrix<T> PointwiseFloor()

    Pointwise applies the floor function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseFloor()

    +

    void PointwiseFloor(Matrix<T> result)

    Pointwise applies the floor function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2844,25 +2843,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2880,15 +2879,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    void PointwiseMaximum(double scalar, Matrix<T> result)

    -
    - - - -
    @@ -2906,6 +2896,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    void PointwiseMaximum(double scalar, Matrix<T> result)

    +
    + + + +
    @@ -2950,7 +2949,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(double scalar)

    +

    void PointwiseMinimum(double scalar, Matrix<T> result)

    @@ -2959,7 +2958,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(double scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMinimum(double scalar)

    @@ -3039,7 +3038,7 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(double exponent)

    +

    void PointwisePower(double exponent, Matrix<T> result)

    @@ -3048,32 +3047,34 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(Matrix<T> exponent)

    -
    Pointwise raise this matrix to an exponent and store the result into the result matrix. +

    Matrix<T> PointwisePower(double exponent)

    +
    -
    -
    Parameters
    - -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    -

    void PointwisePower(double exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. + +
    +
    Parameters
    +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(Matrix<T> exponent)

    +
    Pointwise raise this matrix to an exponent and store the result into the result matrix.
    @@ -3081,8 +3082,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> exponent

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    @@ -3456,6 +3455,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3566,23 +3588,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Vector<T> column)

    -
    Copies the values of the given Vector to the specified column. - - -
    -
    Parameters
    - -
    int columnIndex
    -

    The column to copy the values to.

    -
    Vector<T> column
    -

    The vector to copy the values from.

    -
    - -
    @@ -3613,6 +3618,23 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Vector<T> column)

    +
    Copies the values of the given Vector to the specified column. + + +
    +
    Parameters
    + +
    int columnIndex
    +

    The column to copy the values to.

    +
    Vector<T> column
    +

    The vector to copy the values from.

    +
    + +
    @@ -3641,6 +3663,15 @@ Min(Rows, Columns).

    +
    +
    +
    +

    void SetRow(int rowIndex, Double[] row)

    +
    + + + +
    @@ -3679,19 +3710,10 @@ Min(Rows, Columns).

    -
    - -
    -

    void SetRow(int rowIndex, Double[] row)

    -
    - - - -
    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3700,8 +3722,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3733,7 +3763,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3742,16 +3772,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3760,24 +3782,7 @@ Min(Rows, Columns).

    -

    void Solve(Matrix<T> input, Matrix<T> result)

    -
    Solves a system of linear equations, , with A QR factorized. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    -

    The left hand side Matrix`1 , .

    -
    - - -
    -
    -
    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3786,10 +3791,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3814,7 +3822,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3823,13 +3831,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    + +
    +
    +
    +

    void Solve(Matrix<T> input, Matrix<T> result)

    +
    Solves a system of linear equations, , with A QR factorized. + + +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    +
    @@ -3904,7 +3926,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3913,7 +3935,7 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3922,7 +3944,7 @@ Min(Rows, Columns).

    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3931,15 +3953,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3948,13 +3973,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -4045,7 +4067,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Matrix<T> other)

    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    Subtracts another matrix from this matrix. @@ -4054,13 +4076,10 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the subtraction.

    -
    @@ -4074,16 +4093,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(double scalar)

    -
    - - - - -
    -
    -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Subtract(Matrix<T> other)

    Subtracts another matrix from this matrix. @@ -4092,15 +4102,18 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the subtraction.

    +
    -
    -

    void SubtractFrom(double scalar, Matrix<T> result)

    +
    +

    Matrix<T> Subtract(double scalar)

    @@ -4115,6 +4128,15 @@ does not contain the diagonal elements of this matrix. +
    +
    +
    +

    void SubtractFrom(double scalar, Matrix<T> result)

    +
    + + + +
    @@ -4188,7 +4210,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4197,7 +4219,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +

    string ToMatrixString(string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4260,9 +4282,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4270,10 +4293,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4301,6 +4323,15 @@ The format string is ignored.

    The trace of this matrix

    +
    +
    +
    +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4317,12 +4348,23 @@ The format string is ignored.
    -
    -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. +
    +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4343,9 +4385,9 @@ The format string is ignored.
    -
    -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4353,19 +4395,16 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. +

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the transpose of this matrix with a vector and places the results into the result vector.
    @@ -4373,56 +4412,36 @@ The format string is ignored.
    Vector<T> rightSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    Return
    -
    Matrix<T>
    +
    Vector<T>

    The result of the multiplication.

    -

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4430,10 +4449,13 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4484,7 +4506,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4493,7 +4515,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4502,7 +4524,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4511,7 +4533,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4584,7 +4606,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/SparseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Double/SparseVector.htm index 8098103a..59b7bf1b 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/SparseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/SparseVector.htm @@ -362,8 +362,7 @@

    SparseVector(int length)

    Create a new sparse vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2605,7 +2604,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/Vector.htm b/api/MathNet.Numerics.LinearAlgebra.Double/Vector.htm index 89fb6869..418773ea 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/Vector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/Vector.htm @@ -2458,7 +2458,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Double/index.htm b/api/MathNet.Numerics.LinearAlgebra.Double/index.htm index 7600cbde..70ce811b 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Double/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Double/index.htm @@ -167,7 +167,7 @@
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/Cholesky`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/Cholesky`1.htm index 8af17d9c..7884726b 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/Cholesky`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/Cholesky`1.htm @@ -343,7 +343,7 @@ or positive definite, the constructor will throw an exception. diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/Evd`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/Evd`1.htm index 8a3d1cc0..b09e3eb2 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/Evd`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/Evd`1.htm @@ -366,7 +366,7 @@ A = V*D*Inverse(V) depends upon V.Condition(). diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/GramSchmidt`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/GramSchmidt`1.htm index de15cc42..0e23f7af 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/GramSchmidt`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/GramSchmidt`1.htm @@ -332,7 +332,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/ISolver`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/ISolver`1.htm index 0c7431e3..b70a2042 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/ISolver`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/ISolver`1.htm @@ -256,7 +256,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/LU`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/LU`1.htm index 48244dc4..2835d492 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/LU`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/LU`1.htm @@ -349,7 +349,7 @@ numerical stability. The pivot elements encode a permutation matrix P such that diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/QRMethod.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/QRMethod.htm index a4ab5495..e78b91de 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/QRMethod.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/QRMethod.htm @@ -329,7 +329,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/QR`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/QR`1.htm index 295d6048..e6e12ded 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/QR`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/QR`1.htm @@ -339,7 +339,7 @@ resulting Q matrix is an m x n matrix and the R matrix is an n x n matrix. diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/Svd`1.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/Svd`1.htm index b400b5b9..f395b171 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/Svd`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/Svd`1.htm @@ -369,7 +369,7 @@ by M (though the matrices U and V are not). The diagonal entries of Σ are known diff --git a/api/MathNet.Numerics.LinearAlgebra.Factorization/index.htm b/api/MathNet.Numerics.LinearAlgebra.Factorization/index.htm index b1db3956..4de375f9 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Factorization/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Factorization/index.htm @@ -174,7 +174,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/BiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/BiCgStab.htm index 70e7579e..665716f9 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/BiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/BiCgStab.htm @@ -271,7 +271,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/CompositeSolver.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/CompositeSolver.htm index e78a429d..78c927a5 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/CompositeSolver.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/CompositeSolver.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/DiagonalPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/DiagonalPreconditioner.htm index 22ff4588..23c518f3 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/DiagonalPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/DiagonalPreconditioner.htm @@ -272,7 +272,7 @@ of the matrix diagonal as preconditioning values. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/GpBiCg.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/GpBiCg.htm index b07bf357..782c7745 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/GpBiCg.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/GpBiCg.htm @@ -291,7 +291,7 @@ before switching over to the BiCgStab algorithm. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILU0Preconditioner.htm index 84e21d50..e24d56cf 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILU0Preconditioner.htm @@ -273,7 +273,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILUTPPreconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILUTPPreconditioner.htm index 84bd6c44..0673e4a6 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILUTPPreconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/ILUTPPreconditioner.htm @@ -384,7 +384,7 @@ the preconditioner.

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MILU0Preconditioner.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MILU0Preconditioner.htm index 9675477f..a08320f6 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MILU0Preconditioner.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MILU0Preconditioner.htm @@ -298,7 +298,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MlkBiCgStab.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MlkBiCgStab.htm index 8c8bba74..ca9cb98b 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MlkBiCgStab.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/MlkBiCgStab.htm @@ -299,7 +299,7 @@ Krylov sub-space. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/TFQMR.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/TFQMR.htm index 7a54b939..4b02c2e7 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/TFQMR.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/TFQMR.htm @@ -265,7 +265,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm index be29c2eb..0fafd281 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm @@ -175,7 +175,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/DenseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Single/DenseMatrix.htm index fa36a874..6b6d9513 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/DenseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/DenseMatrix.htm @@ -402,6 +402,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -507,8 +508,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    DenseMatrix(int rows, int columns)

    Create a new dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -516,11 +516,9 @@ Zero-length matrices are not supported.
    -

    DenseMatrix(DenseColumnMajorMatrixStorage<T> storage)

    -
    Create a new dense matrix straight from an initialized matrix storage instance. -The storage is used directly without copying. -Intended for advanced scenarios where you're working directly with -storage for performance or interop reasons. +

    DenseMatrix(int order)

    +
    Create a new square dense matrix with the given number of rows and columns. +All cells of the matrix will be initialized to zero. @@ -528,10 +526,11 @@ storage for performance or interop reasons.
    -

    DenseMatrix(int order)

    -
    Create a new square dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +

    DenseMatrix(DenseColumnMajorMatrixStorage<T> storage)

    +
    Create a new dense matrix straight from an initialized matrix storage instance. +The storage is used directly without copying. +Intended for advanced scenarios where you're working directly with +storage for performance or interop reasons. @@ -605,8 +604,10 @@ Zero-length matrices are not supported.
    -

    DenseMatrix OfColumnArrays(Single[][] columns)

    -
    +

    DenseMatrix OfColumnArrays(IEnumerable<Single[]> columns)

    +
    Create a new dense matrix as a copy of the given column arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -614,10 +615,8 @@ Zero-length matrices are not supported.
    -

    DenseMatrix OfColumnArrays(IEnumerable<Single[]> columns)

    -
    Create a new dense matrix as a copy of the given column arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    DenseMatrix OfColumnArrays(Single[][] columns)

    +
    @@ -661,10 +660,8 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumnVectors(IEnumerable<Vector<float>> columns)

    -
    Create a new dense matrix as a copy of the given column vectors. -This new matrix will be independent from the vectors. -A new memory block will be allocated for storing the matrix. +

    DenseMatrix OfColumnVectors(Vector`1[] columns)

    +
    @@ -672,8 +669,10 @@ A new memory block will be allocated for storing the matrix.
    -

    DenseMatrix OfColumnVectors(Vector`1[] columns)

    -
    +

    DenseMatrix OfColumnVectors(IEnumerable<Vector<float>> columns)

    +
    Create a new dense matrix as a copy of the given column vectors. +This new matrix will be independent from the vectors. +A new memory block will be allocated for storing the matrix. @@ -814,6 +813,15 @@ A new memory block will be allocated for storing the matrix.

    Public Methods

    +
    +

    Matrix<T> Add(float scalar)

    +
    + + + + +
    +

    void Add(float scalar, Matrix<T> result)

    @@ -824,7 +832,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> Add(Matrix<T> other)

    +

    void Add(Matrix<T> other, Matrix<T> result)

    Adds another matrix to this matrix. @@ -833,27 +841,15 @@ A new memory block will be allocated for storing the matrix.
    Matrix<T> other

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the addition.

    -
    - -
    -
    -
    -

    Matrix<T> Add(float scalar)

    -
    - - -
    -

    void Add(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Add(Matrix<T> other)

    Adds another matrix to this matrix. @@ -862,10 +858,13 @@ A new memory block will be allocated for storing the matrix.
    Matrix<T> other

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the addition.

    +
    @@ -969,15 +968,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    -
    -
    -

    void At(int row, int column, float value)

    -
    - - - -
    @@ -1000,6 +990,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    +
    +
    +
    +

    void At(int row, int column, float value)

    +
    + + + +
    @@ -1250,15 +1249,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    A matrix containing the conjugated values.

    -
    - -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. - - - -
    @@ -1275,19 +1265,11 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. - +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    @@ -1310,6 +1292,23 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The result of the multiplication.

    +
    +
    +
    +

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -1333,16 +1332,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result

    The result of the multiplication.

    @@ -1370,16 +1369,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -1472,7 +1471,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    Matrix<T> Divide(float scalar)

    +

    void Divide(float scalar, Matrix<T> result)

    @@ -1481,7 +1480,7 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -

    void Divide(float scalar, Matrix<T> result)

    +

    Matrix<T> Divide(float scalar)

    @@ -1529,15 +1528,6 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi -
    -
    -
    -

    IEnumerable<Vector<float>> EnumerateColumns()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - -
    @@ -1555,36 +1545,45 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    +
    +
    +
    +

    IEnumerable<Vector<float>> EnumerateColumns()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. + + + +
    -

    IEnumerable<Tuple<int, Vector<float>>> EnumerateColumnsIndexed(int index, int length)

    -
    Returns an IEnumerable that can be used to iterate through a subset of all columns of the matrix and their index.
    +

    IEnumerable<Tuple<int, Vector<float>>> EnumerateColumnsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    The enumerator returns a Tuple with the first value being the column index and the second value being the value of the column at that index.
    -
    -
    Parameters
    - -
    int index
    -

    The column to start enumerating over.

    -
    int length
    -

    The number of columns to enumerating over.

    -
    -

    IEnumerable<Tuple<int, Vector<float>>> EnumerateColumnsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    +

    IEnumerable<Tuple<int, Vector<float>>> EnumerateColumnsIndexed(int index, int length)

    +
    Returns an IEnumerable that can be used to iterate through a subset of all columns of the matrix and their index.
    The enumerator returns a Tuple with the first value being the column index and the second value being the value of the column at that index.
    +
    +
    Parameters
    + +
    int index
    +

    The column to start enumerating over.

    +
    int length
    +

    The number of columns to enumerating over.

    +
    @@ -1978,7 +1977,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1988,18 +1987,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -2009,10 +2005,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -2048,8 +2047,8 @@ In a later release, it will be replaced with a sparse implementation.
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -2057,16 +2056,19 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -2074,13 +2076,10 @@ In a later release, it will be replaced with a sparse implementation.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    @@ -2233,7 +2232,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Modulus(float divisor, Matrix<T> result)

    +

    Matrix<T> Modulus(float divisor)

    @@ -2242,7 +2241,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Modulus(float divisor)

    +

    void Modulus(float divisor, Matrix<T> result)

    @@ -2289,36 +2288,38 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    void Multiply(float scalar, Matrix<T> result)

    -
    - - - - -
    -
    -
    -

    Matrix<T> Multiply(float scalar)

    -
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2341,22 +2342,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(float scalar, Matrix<T> result)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    + +
    +
    +
    +

    Matrix<T> Multiply(float scalar)

    +
    + + -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2454,25 +2453,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbs(Matrix<T> result)

    +

    Matrix<T> PointwiseAbs()

    Pointwise applies the abs function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAbs()

    +

    void PointwiseAbs(Matrix<T> result)

    Pointwise applies the abs function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2528,18 +2527,19 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the absolute minimum with the values of another matrix to each value. +

    Matrix<T> PointwiseAbsoluteMinimum(float scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(float scalar, Matrix<T> result)

    +
    + +
    @@ -2560,19 +2560,18 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(float scalar, Matrix<T> result)

    -
    - - +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +
    Pointwise applies the absolute minimum with the values of another matrix to each value. - -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMinimum(float scalar)

    -
    +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    @@ -2602,25 +2601,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAsin(Matrix<T> result)

    +

    Matrix<T> PointwiseAsin()

    Pointwise applies the asin function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAsin()

    +

    void PointwiseAsin(Matrix<T> result)

    Pointwise applies the asin function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2647,17 +2646,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    - - -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    -
    Pointwise applies the atan2 function to each value of the current -matrix and a given other matrix being the 'x' of atan2 and the -'this' matrix being the 'y' - - - -
    @@ -2679,9 +2667,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCeiling()

    -
    Pointwise applies the ceiling function to each value +
    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +
    Pointwise applies the atan2 function to each value of the current +matrix and a given other matrix being the 'x' of atan2 and the +'this' matrix being the 'y' @@ -2703,9 +2693,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseCos()

    -
    Pointwise applies the cos function to each value +
    +

    Matrix<T> PointwiseCeiling()

    +
    Pointwise applies the ceiling function to each value @@ -2725,6 +2715,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    Matrix<T> PointwiseCos()

    +
    Pointwise applies the cos function to each value + + + +
    @@ -2861,31 +2860,31 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2894,13 +2893,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2909,8 +2910,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2935,18 +2934,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(float scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2961,16 +2952,22 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(float scalar)

    -
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2979,6 +2976,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -3056,24 +3055,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. - +

    Matrix<T> PointwisePower(float exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    -

    Matrix<T> PointwisePower(float exponent)

    +

    void PointwisePower(float exponent, Matrix<T> result)

    @@ -3082,10 +3073,18 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwisePower(float exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. +
    +
    Parameters
    + +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -3236,25 +3235,25 @@ of this matrix by another matrix.
    -

    Matrix<T> PointwiseSqrt()

    +

    void PointwiseSqrt(Matrix<T> result)

    Pointwise applies the sqrt function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseSqrt(Matrix<T> result)

    +

    Matrix<T> PointwiseSqrt()

    Pointwise applies the sqrt function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -3284,32 +3283,32 @@ of this matrix by another matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3317,16 +3316,14 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3334,6 +3331,8 @@ of this matrix by another matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    @@ -3473,6 +3472,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3661,8 +3683,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3670,10 +3692,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3682,8 +3700,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3691,6 +3709,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3851,20 +3873,28 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    +
    +
    Parameters
    +
    Vector<T> input
    +

    The solution vector b.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Vector<T>
    +

    The result vector x.

    +
    @@ -3895,28 +3925,20 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Vector<T> input
    -

    The solution vector b.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + -
    -
    Return
    -
    Vector<T>
    -

    The result vector x.

    -
    @@ -3930,7 +3952,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4006,32 +4028,32 @@ does not contain the diagonal elements of this matrix.
    -

    void StrictlyUpperTriangle(Matrix<T> result)

    -
    Puts the strictly upper triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyUpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> StrictlyUpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyUpperTriangle(Matrix<T> result)

    +
    Puts the strictly upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4059,6 +4081,23 @@ does not contain the diagonal elements of this matrix.

    The requested sub-matrix.

    +
    +
    +
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    + +
    @@ -4097,23 +4136,6 @@ does not contain the diagonal elements of this matrix.

    The result of the subtraction.

    -
    - -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    - -
    @@ -4187,8 +4209,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4205,8 +4227,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    +
    @@ -4214,7 +4236,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4318,15 +4340,6 @@ The maximum number of cells can be configured in the -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. - - - -
    @@ -4341,6 +4354,15 @@ The maximum number of cells can be configured in the +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4378,6 +4400,23 @@ The maximum number of cells can be configured in the +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -4435,23 +4474,6 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -4537,31 +4559,31 @@ The maximum number of cells can be configured in the -

    void UpperTriangle(Matrix<T> result)

    -
    Puts the upper triangle of this matrix into the result matrix. +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +

    void UpperTriangle(Matrix<T> result)

    +
    Puts the upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4601,7 +4623,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/DenseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Single/DenseVector.htm index 229489e9..91a9acb8 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/DenseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/DenseVector.htm @@ -386,8 +386,7 @@ storage for performance or interop reasons.

    DenseVector(int length)

    Create a new dense vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2637,7 +2636,7 @@ The maximum number of cells can be configured in the -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/DiagonalMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Single/DiagonalMatrix.htm index e2d04c48..b6e94190 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/DiagonalMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/DiagonalMatrix.htm @@ -389,6 +389,7 @@ entries are set. The exception to this is when the off diagonal elements are
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -493,8 +494,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    DiagonalMatrix(int order)

    Create a new square diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -504,8 +504,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns)

    Create a new diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -515,8 +514,7 @@ Zero-length matrices are not supported.

    DiagonalMatrix(int rows, int columns, float diagonalValue)

    Create a new diagonal matrix with the given number of rows and columns. -All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. -Zero-length matrices are not supported. +All diagonal cells of the matrix will be initialized to the provided value, all non-diagonal ones to zero. @@ -1072,8 +1070,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix. +

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result.
    @@ -1081,16 +1079,19 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result. +

    void ConjugateTransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and places the results into the result matrix.
    @@ -1098,13 +1099,10 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -1149,16 +1147,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result

    The result of the multiplication.

    @@ -1166,16 +1164,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -1325,15 +1323,6 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi -
    -
    -
    -

    IEnumerable<Vector<float>> EnumerateColumns()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. - - - -
    @@ -1353,12 +1342,9 @@ The ordering of the values is unspecified (not necessarily column-wise or row-wi
    -
    -

    IEnumerable<Tuple<int, Vector<float>>> EnumerateColumnsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the column index -and the second value being the value of the column at that index. -
    +
    +

    IEnumerable<Vector<float>> EnumerateColumns()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix. @@ -1383,10 +1369,22 @@ and the second value being the value of the column at that index.
    +
    +
    +
    +

    IEnumerable<Tuple<int, Vector<float>>> EnumerateColumnsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all columns of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the column index +and the second value being the value of the column at that index. +
    + + + +
    -

    IEnumerable<Tuple<int, int, float>> EnumerateIndexed(Zeros zeros)

    +

    IEnumerable<Tuple<int, int, float>> EnumerateIndexed()

    Returns an IEnumerable that can be used to iterate through all values of the matrix and their index.
    The enumerator returns a Tuple with the first two values being the row and column index and the third value being the value of the element at that index. @@ -1399,7 +1397,7 @@ The enumerator will include all values, even if they are zero.
    -

    IEnumerable<Tuple<int, int, float>> EnumerateIndexed()

    +

    IEnumerable<Tuple<int, int, float>> EnumerateIndexed(Zeros zeros)

    Returns an IEnumerable that can be used to iterate through all values of the matrix and their index.
    The enumerator returns a Tuple with the first two values being the row and column index and the third value being the value of the element at that index. @@ -1841,8 +1839,8 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +

    Vector<T> LeftMultiply(Vector<T> leftSide)

    +
    Left multiply a matrix with a vector ( = vector * matrix ).
    @@ -1850,16 +1848,19 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Vector<T> leftSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> LeftMultiply(Vector<T> leftSide)

    -
    Left multiply a matrix with a vector ( = vector * matrix ). +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    @@ -1867,13 +1868,10 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Vector<T> leftSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    @@ -2097,23 +2095,6 @@ on the actual data storage implementation (relevant mostly for sparse matrices).

    The result of the multiplication.

    -
    -
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -2153,17 +2134,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +
    +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    @@ -2180,6 +2164,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2634,25 +2632,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseLog()

    +

    void PointwiseLog(Matrix<T> result)

    Pointwise applies the natural logarithm function to each value. +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The matrix to store the result.

    +
    -

    void PointwiseLog(Matrix<T> result)

    +

    Matrix<T> PointwiseLog()

    Pointwise applies the natural logarithm function to each value. -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -2679,6 +2677,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    +
    +
    +

    void PointwiseMaximum(float scalar, Matrix<T> result)

    +
    + + + +
    @@ -2714,7 +2721,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(float scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(float scalar)

    @@ -2722,11 +2729,17 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseMaximum(float scalar)

    -
    +
    +

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +
    Pointwise applies the minimum with the values of another matrix to each value. + +
    +
    Parameters
    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2741,24 +2754,16 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(float scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    -

    Matrix<T> PointwiseMinimum(Matrix<T> other)

    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the minimum with the values of another matrix to each value. @@ -2767,18 +2772,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -
    -
    -
    -

    Matrix<T> PointwiseMinimum(float scalar)

    -
    - - - -
    @@ -2816,8 +2814,8 @@ of this matrix by another matrix.
    -

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    -
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    +
    Pointwise multiplies this matrix with another matrix.
    @@ -2825,16 +2823,19 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise multiplication of this matrix and other.

    +
    -

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    -
    Pointwise multiplies this matrix with another matrix. +

    void PointwiseMultiply(Matrix<T> other, Matrix<T> result)

    +
    Pointwise multiplies this matrix with another matrix and stores the result into the result matrix.
    @@ -2842,29 +2843,27 @@ of this matrix by another matrix.
    Matrix<T> other

    The matrix to pointwise multiply with this one.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise multiplication of this matrix and other.

    -
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(float exponent)

    +
    -
    -
    Parameters
    -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    -
    + +
    +
    +
    +

    void PointwisePower(float exponent, Matrix<T> result)

    +
    + +
    @@ -2885,19 +2884,18 @@ of this matrix by another matrix.
    -

    void PointwisePower(float exponent, Matrix<T> result)

    -
    - +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. - -
    -
    -
    -

    Matrix<T> PointwisePower(float exponent)

    -
    - +
    +
    Parameters
    +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    @@ -2937,25 +2935,25 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRound(Matrix<T> result)

    +

    Matrix<T> PointwiseRound()

    Pointwise applies the round function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseRound()

    +

    void PointwiseRound(Matrix<T> result)

    Pointwise applies the round function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -3081,32 +3079,32 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseTanh(Matrix<T> result)

    +

    Matrix<T> PointwiseTanh()

    Pointwise applies the tanh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseTanh()

    +

    void PointwiseTanh(Matrix<T> result)

    Pointwise applies the tanh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    Matrix<T> Power(int exponent)

    -
    Multiplies this square matrix with another matrix and returns the result. +

    void Power(int exponent, Matrix<T> result)

    +
    Raises this square matrix to a positive integer exponent and places the results into the result matrix.
    @@ -3114,14 +3112,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    +
    Matrix<T> result
    +

    The result of the power.

    -

    void Power(int exponent, Matrix<T> result)

    -
    Raises this square matrix to a positive integer exponent and places the results into the result matrix. +

    Matrix<T> Power(int exponent)

    +
    Multiplies this square matrix with another matrix and returns the result.
    @@ -3129,8 +3129,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    int exponent

    The positive integer exponent to raise the matrix to.

    -
    Matrix<T> result
    -

    The result of the power.

    @@ -3272,23 +3270,47 @@ also known as the range or image of the corresponding matrix transformation.
    -
    -

    Vector<T> Row(int index)

    -
    Copies a row into an Vector. +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero.
    Parameters
    -
    int index
    -

    The row to copy.

    +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    + +
    +
    +
    +

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    +
    Copies the requested row elements into a new Vector. + + +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy elements from.

    +
    int columnIndex
    +

    The column to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    +
    @@ -3334,23 +3356,22 @@ also known as the range or image of the corresponding matrix transformation.
    -

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    -
    Copies the requested row elements into a new Vector. +

    Vector<T> Row(int index)

    +
    Copies a row into an Vector.
    Parameters
    -
    int rowIndex
    -

    The row to copy elements from.

    -
    int columnIndex
    -

    The column to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The row to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    @@ -3380,15 +3401,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Single[] column)

    -
    - - - -
    @@ -3427,11 +3439,20 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Single[] column)

    +
    + + + +
    -

    void SetDiagonal(Single[] source)

    -
    Copies the values of the given array to the diagonal.
    +

    void SetDiagonal(Vector<T> source)

    +
    Copies the values of the given Vector<T> to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3440,8 +3461,8 @@ this[i,i].
    Parameters
    -
    Single[] source
    -

    The array to copy the values from. The length of the vector should be +

    Vector<T> source
    +

    The vector to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3449,8 +3470,8 @@ Min(Rows, Columns).

    -

    void SetDiagonal(Vector<T> source)

    -
    Copies the values of the given Vector<T> to the diagonal.
    +

    void SetDiagonal(Single[] source)

    +
    Copies the values of the given array to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3459,8 +3480,8 @@ this[i,i].
    Parameters
    -
    Vector<T> source
    -

    The vector to copy the values from. The length of the vector should be +

    Single[] source
    +

    The array to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3477,8 +3498,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Vector<T> row)

    +
    Copies the values of the given Vector to the specified row.
    @@ -3486,10 +3507,6 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3498,8 +3515,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Vector<T> row)

    -
    Copies the values of the given Vector to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3507,6 +3524,10 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> row

    The vector to copy the values from.

    @@ -3515,7 +3536,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3524,16 +3545,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3565,7 +3578,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3574,8 +3587,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3584,7 +3605,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3593,13 +3614,10 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    -
    @@ -3624,7 +3642,7 @@ Min(Rows, Columns).

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3633,10 +3651,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3655,6 +3676,24 @@ Min(Rows, Columns).

    +
    +
    +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    @@ -3681,42 +3720,6 @@ Min(Rows, Columns).

    The result matrix X.

    -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - -
    @@ -3743,10 +3746,28 @@ Min(Rows, Columns).

    The result vector x.

    +
    + +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + +
    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3755,15 +3776,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3772,13 +3796,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -3924,7 +3945,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(float scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(float scalar)

    @@ -3933,7 +3954,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(float scalar)

    +

    void SubtractFrom(float scalar, Matrix<T> result)

    @@ -3994,8 +4015,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    -
    +

    string ToMatrixString(string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4003,8 +4024,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4012,8 +4033,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    +
    @@ -4021,8 +4042,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    +
    @@ -4030,7 +4051,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4039,7 +4060,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -4075,9 +4096,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4085,10 +4107,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4185,6 +4206,26 @@ The format string is ignored.
    +
    +
    +
    +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    +
    @@ -4239,49 +4280,6 @@ The format string is ignored.
    -
    -
    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    - -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    - -
    -
    -
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The solution matrix B.

    -
    Matrix<T> result
    -

    The result matrix X

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    @@ -4294,7 +4292,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4303,7 +4301,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4312,10 +4310,24 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    Matrix<T> result
    +

    The result matrix X

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    @@ -4343,17 +4355,12 @@ The format string is ignored.
    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    -
    @@ -4370,6 +4377,20 @@ The format string is ignored.
    +
    +
    +
    +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    +
    +
    @@ -4400,7 +4421,7 @@ The format string is ignored. diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/Matrix.htm b/api/MathNet.Numerics.LinearAlgebra.Single/Matrix.htm index 42d85843..632b1c3d 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/Matrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/Matrix.htm @@ -366,6 +366,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -459,7 +460,7 @@

    Public Methods

    -

    void Add(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Add(Matrix<T> other)

    Adds another matrix to this matrix. @@ -468,30 +469,22 @@
    Matrix<T> other

    The matrix to add to this matrix.

    -
    Matrix<T> result
    -

    The matrix to store the result of the addition.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the addition.

    +
    -

    Matrix<T> Add(Matrix<T> other)

    -
    Adds another matrix to this matrix. - +

    Matrix<T> Add(float scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to add to this matrix.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the addition.

    -
    @@ -505,10 +498,18 @@
    -

    Matrix<T> Add(float scalar)

    -
    +

    void Add(Matrix<T> other, Matrix<T> result)

    +
    Adds another matrix to this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to add to this matrix.

    +
    Matrix<T> result
    +

    The matrix to store the result of the addition.

    +
    @@ -613,15 +614,6 @@ Use ToRowMajorArray instead if you always need an independent array.

    An array containing the matrix's elements.

    -
    - -
    -

    void At(int row, int column, float value)

    -
    - - - -
    @@ -644,6 +636,15 @@ Use ToRowMajorArray instead if you always need an independent array.

    The requested element.

    + + +
    +

    void At(int row, int column, float value)

    +
    + + + +
    @@ -724,8 +725,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(Func<float, bool> zeroPredicate)

    -
    Set all values that meet the predicate to zero, in-place. +

    void CoerceZero(double threshold)

    +
    Set all values whose absolute value is smaller than the threshold to zero. @@ -733,8 +734,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void CoerceZero(double threshold)

    -
    Set all values whose absolute value is smaller than the threshold to zero. +

    void CoerceZero(Func<float, bool> zeroPredicate)

    +
    Set all values that meet the predicate to zero, in-place. @@ -742,8 +743,8 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. +

    void Column(int index, Vector<T> result)

    +
    Copies a column into to the given Vector.
    @@ -751,19 +752,16 @@ Use ToRowMajorArray instead if you always need an independent array.
    int index

    The column to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    -

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    -
    Copies the requested column elements into a new Vector. +

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    +
    Copies the requested column elements into the given vector.
    @@ -775,51 +773,54 @@ Use ToRowMajorArray instead if you always need an independent array.

    The row to start copying from.

    int length

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the requested elements.

    -
    -

    void Column(int index, Vector<T> result)

    -
    Copies a column into to the given Vector. +

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    +
    Copies the requested column elements into a new Vector.
    Parameters
    -
    int index
    -

    The column to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int columnIndex
    +

    The column to copy elements from.

    +
    int rowIndex
    +

    The row to start copying from.

    +
    int length
    +

    The number of elements to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the requested elements.

    +
    -

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    -
    Copies the requested column elements into the given vector. +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>.
    Parameters
    -
    int columnIndex
    -

    The column to copy elements from.

    -
    int rowIndex
    -

    The row to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The column to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    @@ -865,21 +866,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The condition number of the matrix.

    -
    -
    -
    -

    void Conjugate(Matrix<T> result)

    -
    Complex conjugate each element of this matrix and place the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The result of the conjugation.

    -
    - -
    @@ -896,11 +882,17 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. +
    +

    void Conjugate(Matrix<T> result)

    +
    Complex conjugate each element of this matrix and place the results into the result matrix. + +
    +
    Parameters
    +
    Matrix<T> result
    +

    The result of the conjugation.

    +
    @@ -919,23 +911,12 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result. - +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -956,26 +937,9 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +
    +

    Matrix<T> ConjugateTransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with the conjugate transpose of another matrix and returns the result.
    @@ -1028,6 +992,43 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + + +
    +
    +
    +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    +
    @@ -1622,7 +1623,7 @@ also known as the kernel of the corresponding matrix transformation.
    -

    Matrix<T> KroneckerProduct(Matrix<T> other)

    +

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1632,18 +1633,15 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    +
    Matrix<T> result
    +

    The Kronecker product of the two matrices.

    -
    -
    Return
    -
    Matrix<T>
    -

    The Kronecker product of the two matrices.

    -
    -

    void KroneckerProduct(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> KroneckerProduct(Matrix<T> other)

    Computes the Kronecker product of this matrix with the given matrix. The new matrix is M-by-N with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns. @@ -1653,10 +1651,13 @@ with M = this.Rows * lower.Rows and N = this.Columns * lower.Columns.
    Matrix<T> other

    The other matrix.

    -
    Matrix<T> result
    -

    The Kronecker product of the two matrices.

    +
    +
    Return
    +
    Matrix<T>
    +

    The Kronecker product of the two matrices.

    +
    @@ -1789,8 +1790,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<float, float, float> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<float, float, float> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -1798,8 +1799,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<float, float, float> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<float, float, float> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -1913,34 +1914,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(float scalar, Matrix<T> result)

    -
    - - - - -
    -
    -
    -

    void Multiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with another matrix and places the results into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. +

    Vector<T> Multiply(Vector<T> rightSide)

    +
    Multiplies this matrix by a vector and returns the result.
    @@ -1948,36 +1923,39 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Vector<T> rightSide

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Vector<T>
    +

    The result of the multiplication.

    +
    -

    Vector<T> Multiply(Vector<T> rightSide)

    -
    Multiplies this matrix by a vector and returns the result. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    Return
    -
    Vector<T>
    +
    Matrix<T>

    The result of the multiplication.

    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with another matrix and places the results into the result matrix.
    @@ -1985,13 +1963,10 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2004,17 +1979,29 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. +
    +

    void Multiply(float scalar, Matrix<T> result)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    + +
    +
    +
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2031,6 +2018,20 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2119,15 +2120,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    Matrix<T> PointwiseAbsoluteMaximum(float scalar)

    -
    - - - -
    @@ -2169,6 +2161,24 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAbsoluteMaximum(float scalar)

    +
    + + + + +
    +
    +
    +

    void PointwiseAbsoluteMinimum(float scalar, Matrix<T> result)

    +
    + + + +
    @@ -2187,7 +2197,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(float scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(float scalar)

    @@ -2210,15 +2220,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    - -
    -

    Matrix<T> PointwiseAbsoluteMinimum(float scalar)

    -
    - - - -
    @@ -2294,31 +2295,31 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The other matrix 'y'

    -
    Matrix<T> result
    -

    The matrix with the result and 'x'

    -
    -

    Matrix<T> PointwiseAtan2(Matrix<T> other)

    +

    void PointwiseAtan2(Matrix<T> other, Matrix<T> result)

    Pointwise applies the atan2 function to each value of the current matrix and a given other matrix being the 'x' of atan2 and the 'this' matrix being the 'y' +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The other matrix 'y'

    +
    Matrix<T> result
    +

    The matrix with the result and 'x'

    +
    @@ -2348,34 +2349,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCos(Matrix<T> result)

    +

    Matrix<T> PointwiseCos()

    Pointwise applies the cos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCos()

    +

    void PointwiseCos(Matrix<T> result)

    Pointwise applies the cos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseCosh()

    -
    Pointwise applies the cosh function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2393,6 +2385,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    + + +
    +

    Matrix<T> PointwiseCosh()

    +
    Pointwise applies the cosh function to each value + + + +
    @@ -2454,6 +2455,15 @@ matrix and a given other matrix being the 'x' of atan2 and the +
    + +
    +

    Matrix<T> PointwiseFloor()

    +
    Pointwise applies the floor function to each value + + + +
    @@ -2471,9 +2481,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseFloor()

    -
    Pointwise applies the floor function to each value +
    +

    Matrix<T> PointwiseLog()

    +
    Pointwise applies the natural logarithm function to each value. @@ -2495,9 +2505,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseLog()

    -
    Pointwise applies the natural logarithm function to each value. +
    +

    Matrix<T> PointwiseLog10()

    +
    Pointwise applies the log10 function to each value @@ -2517,19 +2527,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    Matrix<T> PointwiseLog10()

    -
    Pointwise applies the log10 function to each value - - - -
    -

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    +

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2538,6 +2539,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -2562,7 +2565,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMaximum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseMaximum(Matrix<T> other)

    Pointwise applies the maximum with the values of another matrix to each value. @@ -2571,8 +2574,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2750,9 +2751,9 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    +

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix and stores the result into the result matrix. +of this matrix by another matrix.
    @@ -2760,17 +2761,15 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise remainder.

    -

    Matrix<T> PointwiseRemainder(Matrix<T> divisor)

    +

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix. +of this matrix by another matrix and stores the result into the result matrix.
    @@ -2778,6 +2777,8 @@ of this matrix by another matrix.
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise remainder.

    @@ -3117,6 +3118,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3305,10 +3329,22 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, Single[] row)

    -
    +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row. +
    +
    Parameters
    + +
    int rowIndex
    +

    The row to copy the values to.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> row
    +

    The vector to copy the values from.

    +
    @@ -3331,22 +3367,10 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, Single[] row)

    +
    -
    -
    Parameters
    - -
    int rowIndex
    -

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> row
    -

    The vector to copy the values from.

    -
    @@ -3421,27 +3445,27 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    Matrix<T> Solve(Matrix<T> input)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Vector<T> input
    -

    The right hand side vector, .

    +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    +
    Matrix<T>
    +

    The left hand side Matrix`1 , .

    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3450,24 +3474,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    -

    void Solve(Matrix<T> input, Matrix<T> result)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    +
    Vector<T> input
    +

    The right hand side vector, .

    +
    Vector<T> result

    The left hand side Matrix`1 , .

    @@ -3475,7 +3502,7 @@ Min(Rows, Columns).

    -

    Matrix<T> Solve(Matrix<T> input)

    +

    void Solve(Matrix<T> input, Matrix<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3484,18 +3511,15 @@ Min(Rows, Columns).

    Matrix<T> input

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Matrix<T>
    -

    The left hand side Matrix`1 , .

    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3530,33 +3554,16 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Matrix<T> input
    -

    The solution matrix B.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    -
    -
    Return
    -
    Matrix<T>
    -

    The result matrix X.

    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -3565,7 +3572,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3574,11 +3581,28 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result matrix X.

    +
    @@ -3620,32 +3644,32 @@ Min(Rows, Columns).

    -

    void StrictlyLowerTriangle(Matrix<T> result)

    -
    Puts the strictly lower triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyLowerTriangle()

    +
    Returns a new matrix containing the lower triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The lower triangle of this matrix.

    -
    -

    Matrix<T> StrictlyLowerTriangle()

    -
    Returns a new matrix containing the lower triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyLowerTriangle(Matrix<T> result)

    +
    Puts the strictly lower triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The lower triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -3706,18 +3730,10 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    -
    Subtracts another matrix from this matrix. - +

    void Subtract(float scalar, Matrix<T> result)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    -
    @@ -3743,10 +3759,18 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(float scalar, Matrix<T> result)

    -
    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    +
    @@ -3761,7 +3785,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> SubtractFrom(float scalar)

    +

    void SubtractFrom(float scalar, Matrix<T> result)

    @@ -3770,7 +3794,7 @@ does not contain the diagonal elements of this matrix.
    -

    void SubtractFrom(float scalar, Matrix<T> result)

    +

    Matrix<T> SubtractFrom(float scalar)

    @@ -3831,8 +3855,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -3840,8 +3864,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    +
    @@ -3849,7 +3873,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<float, string> formatValue)

    @@ -3867,7 +3891,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3876,7 +3900,7 @@ A new memory block will be allocated for the array.
    -

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    +

    String[,] ToMatrixStringArray(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, int padding, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, Func<float, string> formatValue)

    Returns a string 2D array that summarizes the content of this matrix. @@ -3923,9 +3947,8 @@ The format string is ignored.
    -

    string ToString()

    -
    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    +
    Returns a string that summarizes this matrix. @@ -3933,8 +3956,9 @@ The maximum number of cells can be configured in the -

    string ToString(int maxRows, int maxColumns, string format, IFormatProvider formatProvider)

    -
    Returns a string that summarizes this matrix. +

    string ToString()

    +
    Returns a string that summarizes this matrix. +The maximum number of cells can be configured in the Control class. @@ -3988,8 +4012,8 @@ The maximum number of cells can be configured in the -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix.
    @@ -3997,19 +4021,16 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix. +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result.
    @@ -4017,16 +4038,19 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4034,13 +4058,10 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -4082,8 +4103,8 @@ The maximum number of cells can be configured in the -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4091,8 +4112,34 @@ The maximum number of cells can be configured in the Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    + +
    +
    +
    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. + + +
    +
    Parameters
    + +
    Vector<T> input
    +

    The solution vector b.

    +
    Vector<T> result
    +

    The result vector x.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    @@ -4155,29 +4202,6 @@ The maximum number of cells can be configured in the -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - -
    -
    Parameters
    - -
    Vector<T> input
    -

    The solution vector b.

    -
    Vector<T> result
    -

    The result vector x.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/SparseMatrix.htm b/api/MathNet.Numerics.LinearAlgebra.Single/SparseMatrix.htm index fc4c614a..9157da16 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/SparseMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/SparseMatrix.htm @@ -402,6 +402,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -496,8 +497,7 @@ The underlying storage scheme is 3-array compressed-sparse-row (CSR) Format..

    SparseMatrix(int rows, int columns)

    Create a new sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -519,8 +519,7 @@ storage for performance or interop reasons.

    SparseMatrix(int order)

    Create a new square sparse matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -641,10 +640,8 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfColumnVectors(IEnumerable<Vector<float>> columns)

    -
    Create a new sparse matrix as a copy of the given column vectors. -This new matrix will be independent from the vectors. -A new memory block will be allocated for storing the matrix. +

    SparseMatrix OfColumnVectors(Vector`1[] columns)

    +
    @@ -652,8 +649,10 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfColumnVectors(Vector`1[] columns)

    -
    +

    SparseMatrix OfColumnVectors(IEnumerable<Vector<float>> columns)

    +
    Create a new sparse matrix as a copy of the given column vectors. +This new matrix will be independent from the vectors. +A new memory block will be allocated for storing the matrix. @@ -683,7 +682,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalVector(int rows, int columns, Vector<T> diagonal)

    +

    SparseMatrix OfDiagonalVector(Vector<T> diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -694,7 +693,7 @@ A new memory block will be allocated for storing the matrix.
    -

    SparseMatrix OfDiagonalVector(Vector<T> diagonal)

    +

    SparseMatrix OfDiagonalVector(int rows, int columns, Vector<T> diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -2028,23 +2027,6 @@ In a later release, it will be replaced with a sparse implementation.

    The largest singular value of the matrix.

    -
    -
    -
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. - - -
    -
    Parameters
    - -
    Vector<T> leftSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -2067,16 +2049,18 @@ In a later release, it will be replaced with a sparse implementation.
    -
    -

    void LowerTriangle(Matrix<T> result)

    -
    Puts the lower triangle of this matrix into the result matrix. +
    +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector.
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    Vector<T> leftSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    @@ -2094,6 +2078,21 @@ In a later release, it will be replaced with a sparse implementation.

    The lower triangle of this matrix.

    +
    +
    +
    +

    void LowerTriangle(Matrix<T> result)

    +
    Puts the lower triangle of this matrix into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    + +
    @@ -2261,10 +2260,38 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Multiply(float scalar)

    -
    +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    + +
    +
    +
    +

    void Multiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies this matrix with a vector and places the results into the result vector. + + +
    +
    Parameters
    + +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2290,18 +2317,10 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Multiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies this matrix with a vector and places the results into the result vector. - +

    Matrix<T> Multiply(float scalar)

    +
    -
    -
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    @@ -2323,22 +2342,16 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. - +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Return
    Matrix<T>
    -

    The result of the multiplication.

    +

    A matrix containing the negated values.

    @@ -2356,20 +2369,6 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -
    -
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. - - - -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the negated values.

    -
    -
    @@ -2461,10 +2460,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(float scalar)

    -
    +

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    +
    Pointwise applies the absolute maximum with the values of another matrix to each value. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    @@ -2496,22 +2501,16 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    -
    Pointwise applies the absolute maximum with the values of another matrix to each value. - +

    Matrix<T> PointwiseAbsoluteMaximum(float scalar)

    +
    -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2520,15 +2519,13 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -

    void PointwiseAbsoluteMinimum(float scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(float scalar)

    @@ -2537,7 +2534,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(float scalar)

    +

    void PointwiseAbsoluteMinimum(float scalar, Matrix<T> result)

    @@ -2546,7 +2543,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2555,40 +2552,33 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseAcos(Matrix<T> result)

    +

    Matrix<T> PointwiseAcos()

    Pointwise applies the acos function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseAcos()

    +

    void PointwiseAcos(Matrix<T> result)

    Pointwise applies the acos function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseAsin()

    -
    Pointwise applies the asin function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2606,6 +2596,15 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    Matrix<T> PointwiseAsin()

    +
    Pointwise applies the asin function to each value + + + +
    @@ -2711,32 +2710,32 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCosh(Matrix<T> result)

    +

    Matrix<T> PointwiseCosh()

    Pointwise applies the cosh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCosh()

    +

    void PointwiseCosh(Matrix<T> result)

    Pointwise applies the cosh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    -
    Pointwise divide this matrix by another matrix and stores the result into the result matrix. +

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    +
    Pointwise divide this matrix by another matrix.
    @@ -2744,16 +2743,19 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise division.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise division of this matrix and divisor.

    +
    -

    Matrix<T> PointwiseDivide(Matrix<T> divisor)

    -
    Pointwise divide this matrix by another matrix. +

    void PointwiseDivide(Matrix<T> divisor, Matrix<T> result)

    +
    Pointwise divide this matrix by another matrix and stores the result into the result matrix.
    @@ -2761,13 +2763,10 @@ matrix and a given other matrix being the 'x' of atan2 and the
    Matrix<T> divisor

    The pointwise denominator matrix to use.

    +
    Matrix<T> result
    +

    The matrix to store the result of the pointwise division.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise division of this matrix and divisor.

    -
    @@ -2796,25 +2795,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseFloor(Matrix<T> result)

    +

    Matrix<T> PointwiseFloor()

    Pointwise applies the floor function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseFloor()

    +

    void PointwiseFloor(Matrix<T> result)

    Pointwise applies the floor function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2844,25 +2843,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseLog10(Matrix<T> result)

    +

    Matrix<T> PointwiseLog10()

    Pointwise applies the log10 function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseLog10()

    +

    void PointwiseLog10(Matrix<T> result)

    Pointwise applies the log10 function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2880,15 +2879,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    void PointwiseMaximum(float scalar, Matrix<T> result)

    -
    - - - -
    @@ -2906,6 +2896,15 @@ matrix and a given other matrix being the 'x' of atan2 and the
    +
    +
    +
    +

    void PointwiseMaximum(float scalar, Matrix<T> result)

    +
    + + + +
    @@ -2950,7 +2949,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(float scalar)

    +

    void PointwiseMinimum(float scalar, Matrix<T> result)

    @@ -2959,7 +2958,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseMinimum(float scalar, Matrix<T> result)

    +

    Matrix<T> PointwiseMinimum(float scalar)

    @@ -3039,7 +3038,7 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(float exponent)

    +

    void PointwisePower(float exponent, Matrix<T> result)

    @@ -3048,32 +3047,34 @@ of this matrix by another matrix and stores the result into the result matrix.
    -

    Matrix<T> PointwisePower(Matrix<T> exponent)

    -
    Pointwise raise this matrix to an exponent and store the result into the result matrix. +

    Matrix<T> PointwisePower(float exponent)

    +
    -
    -
    Parameters
    - -
    Matrix<T> exponent
    -

    The exponent to raise this matrix values to.

    -
    -

    void PointwisePower(float exponent, Matrix<T> result)

    -
    +

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    +
    Pointwise raise this matrix to an exponent. + +
    +
    Parameters
    +
    Matrix<T> exponent
    +

    The exponent to raise this matrix values to.

    +
    Matrix<T> result
    +

    The matrix to store the result into.

    +
    -

    void PointwisePower(Matrix<T> exponent, Matrix<T> result)

    -
    Pointwise raise this matrix to an exponent. +

    Matrix<T> PointwisePower(Matrix<T> exponent)

    +
    Pointwise raise this matrix to an exponent and store the result into the result matrix.
    @@ -3081,8 +3082,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    Matrix<T> exponent

    The exponent to raise this matrix values to.

    -
    Matrix<T> result
    -

    The matrix to store the result into.

    @@ -3456,6 +3455,29 @@ also known as the range or image of the corresponding matrix transformation.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    @@ -3566,23 +3588,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and -
    -
    -
    -

    void SetColumn(int columnIndex, Vector<T> column)

    -
    Copies the values of the given Vector to the specified column. - - -
    -
    Parameters
    - -
    int columnIndex
    -

    The column to copy the values to.

    -
    Vector<T> column
    -

    The vector to copy the values from.

    -
    - -
    @@ -3613,6 +3618,23 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    +
    +
    +
    +

    void SetColumn(int columnIndex, Vector<T> column)

    +
    Copies the values of the given Vector to the specified column. + + +
    +
    Parameters
    + +
    int columnIndex
    +

    The column to copy the values to.

    +
    Vector<T> column
    +

    The vector to copy the values from.

    +
    + +
    @@ -3641,6 +3663,15 @@ Min(Rows, Columns).

    +
    +
    +
    +

    void SetRow(int rowIndex, Single[] row)

    +
    + + + +
    @@ -3679,19 +3710,10 @@ Min(Rows, Columns).

    -
    - -
    -

    void SetRow(int rowIndex, Single[] row)

    -
    - - - -
    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3700,8 +3722,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3733,7 +3763,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3742,16 +3772,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3760,24 +3782,7 @@ Min(Rows, Columns).

    -

    void Solve(Matrix<T> input, Matrix<T> result)

    -
    Solves a system of linear equations, , with A QR factorized. - - -
    -
    Parameters
    - -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    -

    The left hand side Matrix`1 , .

    -
    - - -
    -
    -
    -

    void Solve(Vector<T> input, Vector<T> result)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -3786,10 +3791,13 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    -
    Vector<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    +
    @@ -3814,7 +3822,7 @@ Min(Rows, Columns).

    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Vector<T> input, Vector<T> result)

    Solves a system of linear equations, , with A QR factorized. @@ -3823,13 +3831,27 @@ Min(Rows, Columns).

    Vector<T> input

    The right hand side vector, .

    +
    Vector<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    + +
    +
    +
    +

    void Solve(Matrix<T> input, Matrix<T> result)

    +
    Solves a system of linear equations, , with A QR factorized. + + +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    +
    @@ -3904,7 +3926,7 @@ Min(Rows, Columns).

    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3913,7 +3935,7 @@ Min(Rows, Columns).

    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -3922,7 +3944,7 @@ Min(Rows, Columns).

    -

    void Stack(Matrix<T> lower, Matrix<T> result)

    +

    Matrix<T> Stack(Matrix<T> lower)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3931,15 +3953,18 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    -
    Matrix<T> result
    -

    The combined matrix.

    +
    +
    Return
    +
    Matrix<T>
    +

    The combined matrix.

    +
    -

    Matrix<T> Stack(Matrix<T> lower)

    +

    void Stack(Matrix<T> lower, Matrix<T> result)

    Stacks this matrix on top of the given matrix and places the result into the result matrix. @@ -3948,13 +3973,10 @@ Min(Rows, Columns).

    Matrix<T> lower

    The matrix to stack this matrix upon.

    +
    Matrix<T> result
    +

    The combined matrix.

    -
    -
    Return
    -
    Matrix<T>
    -

    The combined matrix.

    -
    @@ -4045,7 +4067,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Matrix<T> other)

    +

    void Subtract(Matrix<T> other, Matrix<T> result)

    Subtracts another matrix from this matrix. @@ -4054,13 +4076,10 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the subtraction.

    -
    @@ -4074,16 +4093,7 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(float scalar)

    -
    - - - - -
    -
    -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Subtract(Matrix<T> other)

    Subtracts another matrix from this matrix. @@ -4092,15 +4102,18 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the subtraction.

    +
    -
    -

    void SubtractFrom(float scalar, Matrix<T> result)

    +
    +

    Matrix<T> Subtract(float scalar)

    @@ -4115,6 +4128,15 @@ does not contain the diagonal elements of this matrix. +
    +
    +
    +

    void SubtractFrom(float scalar, Matrix<T> result)

    +
    + + + +
    @@ -4188,7 +4210,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(string format, IFormatProvider provider)

    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4197,7 +4219,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +

    string ToMatrixString(string format, IFormatProvider provider)

    Returns a string that summarizes the content of this matrix. @@ -4260,9 +4282,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4270,10 +4293,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4301,6 +4323,15 @@ The format string is ignored.

    The trace of this matrix

    +
    +
    +
    +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. + + + +
    @@ -4317,12 +4348,23 @@ The format string is ignored.
    -
    -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. +
    +

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    +
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4343,9 +4385,9 @@ The format string is ignored.
    -
    -

    Matrix<T> TransposeAndMultiply(Matrix<T> other)

    -
    Multiplies this matrix with transpose of another matrix and returns the result. +
    +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix.
    @@ -4353,19 +4395,16 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    -
    Multiplies the transpose of this matrix by a vector and returns the result. +

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the transpose of this matrix with a vector and places the results into the result vector.
    @@ -4373,56 +4412,36 @@ The format string is ignored.
    Vector<T> rightSide

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Vector<T>
    -

    The result of the multiplication.

    -
    -

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the transpose of this matrix with another matrix and returns the result. +

    Vector<T> TransposeThisAndMultiply(Vector<T> rightSide)

    +
    Multiplies the transpose of this matrix by a vector and returns the result.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    Return
    -
    Matrix<T>
    +
    Vector<T>

    The result of the multiplication.

    -

    void TransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the transpose of this matrix with a vector and places the results into the result vector. - - -
    -
    Parameters
    - -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - - -
    -
    -
    -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> TransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the transpose of this matrix with another matrix and returns the result.
    @@ -4430,10 +4449,13 @@ The format string is ignored.
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -4484,7 +4506,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4493,7 +4515,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4502,7 +4524,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4511,7 +4533,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    @@ -4584,7 +4606,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/SparseVector.htm b/api/MathNet.Numerics.LinearAlgebra.Single/SparseVector.htm index 7d963610..3ae427f1 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/SparseVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/SparseVector.htm @@ -362,8 +362,7 @@

    SparseVector(int length)

    Create a new sparse vector with the given length. -All cells of the vector will be initialized to zero. -Zero-length vectors are not supported. +All cells of the vector will be initialized to zero. @@ -2605,7 +2604,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/Vector.htm b/api/MathNet.Numerics.LinearAlgebra.Single/Vector.htm index c65bfc97..c81c2876 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/Vector.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/Vector.htm @@ -2458,7 +2458,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Single/index.htm b/api/MathNet.Numerics.LinearAlgebra.Single/index.htm index 036036e2..aab9d43e 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Single/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Single/index.htm @@ -167,7 +167,7 @@
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/CancellationStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/CancellationStopCriterion`1.htm index e37b11ac..18a6e500 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/CancellationStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/CancellationStopCriterion`1.htm @@ -336,7 +336,7 @@ calculation has moved forwards at least one step. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/DelegateStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/DelegateStopCriterion`1.htm index a91cb6eb..a83acfc1 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/DelegateStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/DelegateStopCriterion`1.htm @@ -317,7 +317,7 @@ calculation has moved forwards at least one step. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/DivergenceStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/DivergenceStopCriterion`1.htm index d4f7658d..d63a4c39 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/DivergenceStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/DivergenceStopCriterion`1.htm @@ -340,7 +340,7 @@ issuing a divergence warning. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/FailureStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/FailureStopCriterion`1.htm index 5f4b6f3b..b76c9a77 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/FailureStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/FailureStopCriterion`1.htm @@ -316,7 +316,7 @@ calculation has moved forwards at least one step. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterationStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterationStopCriterion`1.htm index 3659353e..7c444e68 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterationStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterationStopCriterion`1.htm @@ -261,7 +261,7 @@ calculation. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolverSetup`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolverSetup`1.htm index 017980e1..3044d563 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolverSetup`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolverSetup`1.htm @@ -255,7 +255,7 @@ setup information around. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolver`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolver`1.htm index 9db35726..c3974f83 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolver`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolver`1.htm @@ -222,7 +222,7 @@ solution vector and x is the unknown vector. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm index c863c52d..19d490f6 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm @@ -239,7 +239,7 @@ if the changes occur after creating the preconditioner.

    diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationCountStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationCountStopCriterion`1.htm index 6bc3e048..322bfa57 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationCountStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationCountStopCriterion`1.htm @@ -371,7 +371,7 @@ to perform. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm index 740da99c..05092e2d 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm @@ -399,7 +399,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm index 7894bc00..4d0fed13 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm @@ -354,7 +354,7 @@ calculation has moved forwards at least one step. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/ResidualStopCriterion`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/ResidualStopCriterion`1.htm index 9e3ff07e..4568e4e6 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/ResidualStopCriterion`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/ResidualStopCriterion`1.htm @@ -342,7 +342,7 @@ below the maximum before the calculation is considered converged. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/SolverSetup`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/SolverSetup`1.htm index 99cc6d6a..e0688fa3 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/SolverSetup`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/SolverSetup`1.htm @@ -280,7 +280,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/UnitPreconditioner`1.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/UnitPreconditioner`1.htm index 802ff078..666a7cfc 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/UnitPreconditioner`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/UnitPreconditioner`1.htm @@ -288,7 +288,7 @@ a preconditioner. diff --git a/api/MathNet.Numerics.LinearAlgebra.Solvers/index.htm b/api/MathNet.Numerics.LinearAlgebra.Solvers/index.htm index 37a34536..5e3c26c7 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Solvers/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Solvers/index.htm @@ -198,7 +198,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/DenseColumnMajorMatrixStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/DenseColumnMajorMatrixStorage`1.htm index 23bc519b..2471f36f 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/DenseColumnMajorMatrixStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/DenseColumnMajorMatrixStorage`1.htm @@ -882,7 +882,7 @@ False if some fields are fixed, like on a diagonal matrix. diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/DenseVectorStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/DenseVectorStorage`1.htm index b571cdc5..ddcab5d9 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/DenseVectorStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/DenseVectorStorage`1.htm @@ -596,7 +596,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/DiagonalMatrixStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/DiagonalMatrixStorage`1.htm index 790dab5c..f034f961 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/DiagonalMatrixStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/DiagonalMatrixStorage`1.htm @@ -782,7 +782,7 @@ False if some fields are fixed, like on a diagonal matrix. diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/MatrixStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/MatrixStorage`1.htm index fa8045bf..41d3ef82 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/MatrixStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/MatrixStorage`1.htm @@ -735,7 +735,7 @@ False if some fields are fixed, like on a diagonal matrix. diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/SparseCompressedRowMatrixStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/SparseCompressedRowMatrixStorage`1.htm index 22fc7024..c1130e27 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/SparseCompressedRowMatrixStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/SparseCompressedRowMatrixStorage`1.htm @@ -166,6 +166,9 @@
  • OfColumnEnumerables
  • OfColumnMajorList
  • OfColumnVectors
    • +
  • OfCompressedSparseColumnFormat
    • +
  • OfCompressedSparseRowFormat
    • +
  • OfCoordinateFormat
  • OfDiagonalInit
  • OfIndexedEnumerable
  • OfInit
    • @@ -217,6 +220,7 @@
  • MapSubMatrixIndexedTo<TU>
  • MapTo<TU>
  • Normalize
    • +
  • NormalizeDuplicates
  • NormalizeOrdering
  • NormalizeZeros
  • PopulateExplicitZerosOnDiagonal
    • @@ -295,6 +299,109 @@ + + +
    +

    SparseCompressedRowMatrixStorage<T> OfCompressedSparseColumnFormat(int rows, int columns, int valueCount, Int32[] rowIndices, Int32[] columnPointers, T[] values)

    +
    Create a new sparse matrix storage from a compressed sparse column (CSC) format. +This new storage will be independent from the given arrays. +A new memory block will be allocated.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    + + +
    +
    Parameters
    + +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowIndices
    +

    The row index array of the compressed sparse column format.

    +
    Int32[] columnPointers
    +

    The column pointer array of the compressed sparse column format.

    +
    T[] values
    +

    The data array of the compressed sparse column format.

    +
    + +
    +
    Return
    +
    SparseCompressedRowMatrixStorage<T>
    +

    The sparse storage from the compressed sparse column format.

    +
    + +
    +
    +
    +

    SparseCompressedRowMatrixStorage<T> OfCompressedSparseRowFormat(int rows, int columns, int valueCount, Int32[] rowPointers, Int32[] columnIndices, T[] values)

    +
    Create a new sparse storage from a compressed sparse row (CSR) format. +This new storage will be independent from the given arrays. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    + + +
    +
    Parameters
    + +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowPointers
    +

    The row pointer array of the compressed sparse row format.

    +
    Int32[] columnIndices
    +

    The column index array of the compressed sparse row format.

    +
    T[] values
    +

    The data array of the compressed sparse row format.

    +
    + +
    +
    Return
    +
    SparseCompressedRowMatrixStorage<T>
    +

    The sparse storage from the compressed sparse row format.

    +
    + +
    +
    +
    +

    SparseCompressedRowMatrixStorage<T> OfCoordinateFormat(int rows, int columns, int valueCount, Int32[] rowIndices, Int32[] columnIndices, T[] values)

    +
    Create a new sparse storage from a coordinate (COO) format. +This new storage will be independent from the given arrays. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and +explicit zeros will be not intentionally removed. +
    + + +
    +
    Parameters
    + +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowIndices
    +

    The row index array of the coordinate format.

    +
    Int32[] columnIndices
    +

    The column index array of the coordinate format.

    +
    T[] values
    +

    The data array of the coordinate format.

    +
    + +
    +
    Return
    +
    SparseCompressedRowMatrixStorage<T>
    +

    The sparse storage from the coordinate format.

    +
    +
    @@ -804,6 +911,15 @@ False if the field is fixed, like an off-diagonal field on a diagonal matrix. +
    + +
    +

    void NormalizeDuplicates()

    +
    Eliminate duplicate entries by adding them together. + + + +
    @@ -994,7 +1110,7 @@ array using the row-major storage mapping described in a compressed sparse row (
    diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/SparseVectorStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/SparseVectorStorage`1.htm index 7312274d..9cc87fe2 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/SparseVectorStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/SparseVectorStorage`1.htm @@ -611,7 +611,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/VectorStorage`1.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/VectorStorage`1.htm index 00366ffd..6575e54a 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/VectorStorage`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/VectorStorage`1.htm @@ -555,7 +555,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra.Storage/index.htm b/api/MathNet.Numerics.LinearAlgebra.Storage/index.htm index c9cfa947..8d782e2f 100644 --- a/api/MathNet.Numerics.LinearAlgebra.Storage/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra.Storage/index.htm @@ -167,7 +167,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra/CreateMatrix.htm b/api/MathNet.Numerics.LinearAlgebra/CreateMatrix.htm index 57a006f7..5b5b878e 100644 --- a/api/MathNet.Numerics.LinearAlgebra/CreateMatrix.htm +++ b/api/MathNet.Numerics.LinearAlgebra/CreateMatrix.htm @@ -233,6 +233,9 @@
  • SparseDiagonal<T>
  • SparseDiagonal<T>
  • SparseDiagonal<T>
    • +
  • SparseFromCompressedSparseColumnFormat<T>
    • +
  • SparseFromCompressedSparseRowFormat<T>
    • +
  • SparseFromCoordinateFormat<T>
  • SparseIdentity<T>
  • SparseIdentity<T>
  • SparseOfArray<T>
    • @@ -269,11 +272,8 @@

    Public Static Functions

    -

    Matrix<T> Dense<T>(DenseColumnMajorMatrixStorage<T> storage)

    -
    Create a new dense matrix straight from an initialized matrix storage instance. -The storage is used directly without copying. -Intended for advanced scenarios where you're working directly with -storage for performance or interop reasons. +

    Matrix<T> Dense<T>(int rows, int columns, Func<int, int, T> init)

    +
    Create a new dense matrix and initialize each value using the provided init function. @@ -281,10 +281,8 @@ storage for performance or interop reasons.
    -

    Matrix<T> Dense<T>(int rows, int columns, T[] storage)

    -
    Create a new dense matrix with the given number of rows and columns directly binding to a raw array. -The array is assumed to be in column-major order (column by column) and is used directly without copying. -Very efficient, but changes to the array and the matrix will affect each other. +

    Matrix<T> Dense<T>(int rows, int columns, T value)

    +
    Create a new dense matrix and initialize each value to the same provided value. @@ -292,8 +290,10 @@ Very efficient, but changes to the array and the matrix will affect each other.
    -

    Matrix<T> Dense<T>(int rows, int columns, T value)

    -
    Create a new dense matrix and initialize each value to the same provided value. +

    Matrix<T> Dense<T>(int rows, int columns, T[] storage)

    +
    Create a new dense matrix with the given number of rows and columns directly binding to a raw array. +The array is assumed to be in column-major order (column by column) and is used directly without copying. +Very efficient, but changes to the array and the matrix will affect each other. @@ -301,8 +301,9 @@ Very efficient, but changes to the array and the matrix will affect each other.
    -

    Matrix<T> Dense<T>(int rows, int columns, Func<int, int, T> init)

    -
    Create a new dense matrix and initialize each value using the provided init function. +

    Matrix<T> Dense<T>(int rows, int columns)

    +
    Create a new dense matrix with the given number of rows and columns. +All cells of the matrix will be initialized to zero. @@ -310,10 +311,11 @@ Very efficient, but changes to the array and the matrix will affect each other.
    -

    Matrix<T> Dense<T>(int rows, int columns)

    -
    Create a new dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +

    Matrix<T> Dense<T>(DenseColumnMajorMatrixStorage<T> storage)

    +
    Create a new dense matrix straight from an initialized matrix storage instance. +The storage is used directly without copying. +Intended for advanced scenarios where you're working directly with +storage for performance or interop reasons. @@ -321,7 +323,7 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseDiagonal<T>(int rows, int columns, T value)

    +

    Matrix<T> DenseDiagonal<T>(int order, T value)

    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. @@ -330,8 +332,8 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseDiagonal<T>(int order, T value)

    -
    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. +

    Matrix<T> DenseDiagonal<T>(int rows, int columns, Func<int, T> init)

    +
    Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. @@ -339,8 +341,8 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseDiagonal<T>(int rows, int columns, Func<int, T> init)

    -
    Create a new diagonal dense matrix and initialize each diagonal value using the provided init function. +

    Matrix<T> DenseDiagonal<T>(int rows, int columns, T value)

    +
    Create a new diagonal dense matrix and initialize each diagonal value to the same provided value. @@ -348,7 +350,7 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseIdentity<T>(int order)

    +

    Matrix<T> DenseIdentity<T>(int rows, int columns)

    Create a new diagonal dense identity matrix with a one-diagonal. @@ -357,7 +359,7 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseIdentity<T>(int rows, int columns)

    +

    Matrix<T> DenseIdentity<T>(int order)

    Create a new diagonal dense identity matrix with a one-diagonal. @@ -375,8 +377,10 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseOfColumnArrays<T>(T[][] columns)

    -
    +

    Matrix<T> DenseOfColumnArrays<T>(IEnumerable<T[]> columns)

    +
    Create a new dense matrix of T as a copy of the given column arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -384,10 +388,8 @@ Zero-length matrices are not supported.
    -

    Matrix<T> DenseOfColumnArrays<T>(IEnumerable<T[]> columns)

    -
    Create a new dense matrix of T as a copy of the given column arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    Matrix<T> DenseOfColumnArrays<T>(T[][] columns)

    +
    @@ -407,7 +409,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfColumns<T>(IEnumerable<IEnumerable<T>> data)

    +

    Matrix<T> DenseOfColumns<T>(int rows, int columns, IEnumerable<IEnumerable<T>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable columns. Each enumerable in the master enumerable specifies a column. This new matrix will be independent from the enumerables. @@ -419,7 +421,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfColumns<T>(int rows, int columns, IEnumerable<IEnumerable<T>> data)

    +

    Matrix<T> DenseOfColumns<T>(IEnumerable<IEnumerable<T>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable columns. Each enumerable in the master enumerable specifies a column. This new matrix will be independent from the enumerables. @@ -431,8 +433,10 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfColumnVectors<T>(Vector`1[] columns)

    -
    +

    Matrix<T> DenseOfColumnVectors<T>(IEnumerable<Vector<T>> columns)

    +
    Create a new dense matrix as a copy of the given column vectors. +This new matrix will be independent from the vectors. +A new memory block will be allocated for storing the matrix. @@ -440,10 +444,8 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfColumnVectors<T>(IEnumerable<Vector<T>> columns)

    -
    Create a new dense matrix as a copy of the given column vectors. -This new matrix will be independent from the vectors. -A new memory block will be allocated for storing the matrix. +

    Matrix<T> DenseOfColumnVectors<T>(Vector`1[] columns)

    +
    @@ -451,7 +453,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfDiagonalArray<T>(T[] diagonal)

    +

    Matrix<T> DenseOfDiagonalArray<T>(int rows, int columns, T[] diagonal)

    Create a new dense matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -462,7 +464,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfDiagonalArray<T>(int rows, int columns, T[] diagonal)

    +

    Matrix<T> DenseOfDiagonalArray<T>(T[] diagonal)

    Create a new dense matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -473,7 +475,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfDiagonalVector<T>(Vector<T> diagonal)

    +

    Matrix<T> DenseOfDiagonalVector<T>(int rows, int columns, Vector<T> diagonal)

    Create a new dense matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -484,7 +486,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfDiagonalVector<T>(int rows, int columns, Vector<T> diagonal)

    +

    Matrix<T> DenseOfDiagonalVector<T>(Vector<T> diagonal)

    Create a new dense matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -527,10 +529,8 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfRowArrays<T>(IEnumerable<T[]> rows)

    -
    Create a new dense matrix of T as a copy of the given row arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    Matrix<T> DenseOfRowArrays<T>(T[][] rows)

    +
    @@ -538,8 +538,10 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfRowArrays<T>(T[][] rows)

    -
    +

    Matrix<T> DenseOfRowArrays<T>(IEnumerable<T[]> rows)

    +
    Create a new dense matrix of T as a copy of the given row arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -547,7 +549,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfRows<T>(IEnumerable<IEnumerable<T>> data)

    +

    Matrix<T> DenseOfRows<T>(int rows, int columns, IEnumerable<IEnumerable<T>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable rows. Each enumerable in the master enumerable specifies a row. This new matrix will be independent from the enumerables. @@ -559,7 +561,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DenseOfRows<T>(int rows, int columns, IEnumerable<IEnumerable<T>> data)

    +

    Matrix<T> DenseOfRows<T>(IEnumerable<IEnumerable<T>> data)

    Create a new dense matrix as a copy of the given enumerable of enumerable rows. Each enumerable in the master enumerable specifies a row. This new matrix will be independent from the enumerables. @@ -568,15 +570,6 @@ A new memory block will be allocated for storing the matrix. -
    -
    -
    -

    Matrix<T> DenseOfRowVectors<T>(Vector`1[] rows)

    -
    - - - -
    @@ -590,9 +583,9 @@ A new memory block will be allocated for storing the matrix.
    -
    -

    Matrix<T> Diagonal<T>(int rows, int columns, Func<int, T> init)

    -
    Create a new diagonal matrix and initialize each diagonal value using the provided init function. +
    +

    Matrix<T> DenseOfRowVectors<T>(Vector`1[] rows)

    +
    @@ -614,8 +607,7 @@ storage for performance or interop reasons.

    Matrix<T> Diagonal<T>(int rows, int columns)

    Create a new diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -651,6 +643,15 @@ Very efficient, but changes to the array and the matrix will affect each other. +
    +
    +
    +

    Matrix<T> Diagonal<T>(int rows, int columns, Func<int, T> init)

    +
    Create a new diagonal matrix and initialize each diagonal value using the provided init function. + + + +
    @@ -672,7 +673,7 @@ Very efficient, but changes to the array and the matrix will affect each other.
    -

    Matrix<T> DiagonalOfDiagonalArray<T>(T[] diagonal)

    +

    Matrix<T> DiagonalOfDiagonalArray<T>(int rows, int columns, T[] diagonal)

    Create a new diagonal matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -683,7 +684,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> DiagonalOfDiagonalArray<T>(int rows, int columns, T[] diagonal)

    +

    Matrix<T> DiagonalOfDiagonalArray<T>(T[] diagonal)

    Create a new diagonal matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -716,8 +717,8 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> Random<T>(int rows, int columns, IContinuousDistribution distribution)

    -
    Create a new dense matrix with values sampled from the provided random distribution. +

    Matrix<T> Random<T>(int rows, int columns, int seed)

    +
    Create a new dense matrix with values sampled from the standard distribution with a system random source. @@ -725,8 +726,8 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> Random<T>(int rows, int columns, int seed)

    -
    Create a new dense matrix with values sampled from the standard distribution with a system random source. +

    Matrix<T> Random<T>(int rows, int columns, IContinuousDistribution distribution)

    +
    Create a new dense matrix with values sampled from the provided random distribution. @@ -797,6 +798,15 @@ of two samples from the provided random distribution. +
    +
    +
    +

    Matrix<T> SameAs<T, TU>(Matrix<T> example, int rows, int columns, bool fullyMutable)

    +
    Create a new matrix with the same kind of the provided example. + + + +
    @@ -808,9 +818,18 @@ of two samples from the provided random distribution.
    -
    -

    Matrix<T> SameAs<T, TU>(Matrix<T> example, int rows, int columns, bool fullyMutable)

    -
    Create a new matrix with the same kind of the provided example. +
    +

    Matrix<T> Sparse<T>(int rows, int columns, Func<int, int, T> init)

    +
    Create a new sparse matrix and initialize each value using the provided init function. + + + + +
    +
    +
    +

    Matrix<T> Sparse<T>(int rows, int columns, T value)

    +
    Create a new sparse matrix and initialize each value to the same provided value. @@ -846,18 +865,18 @@ storage for performance or interop reasons.
    -
    -

    Matrix<T> Sparse<T>(int rows, int columns, T value)

    -
    Create a new sparse matrix and initialize each value to the same provided value. +
    +

    Matrix<T> SparseDiagonal<T>(int rows, int columns, Func<int, T> init)

    +
    Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function.
    -
    -

    Matrix<T> Sparse<T>(int rows, int columns, Func<int, int, T> init)

    -
    Create a new sparse matrix and initialize each value using the provided init function. +
    +

    Matrix<T> SparseDiagonal<T>(int order, T value)

    +
    Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. @@ -865,7 +884,7 @@ storage for performance or interop reasons.
    -

    Matrix<T> SparseDiagonal<T>(int order, T value)

    +

    Matrix<T> SparseDiagonal<T>(int rows, int columns, T value)

    Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. @@ -873,26 +892,110 @@ storage for performance or interop reasons.
    -
    -

    Matrix<T> SparseDiagonal<T>(int rows, int columns, T value)

    -
    Create a new diagonal sparse matrix and initialize each diagonal value to the same provided value. +
    +

    Matrix<T> SparseFromCompressedSparseColumnFormat<T>(int rows, int columns, int valueCount, Int32[] rowIndices, Int32[] columnPointers, T[] values)

    +
    Create a new sparse matrix from a compressed sparse column format. +This new matrix will be independent from the given arrays. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    + + +
    +
    Parameters
    +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowIndices
    +

    The row index array of the compressed sparse column format.

    +
    Int32[] columnPointers
    +

    The column pointer array of the compressed sparse column format.

    +
    T[] values
    +

    The data array of the compressed sparse column format.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The sparse matrix from the compressed sparse column format.

    +
    + +
    +
    +
    +

    Matrix<T> SparseFromCompressedSparseRowFormat<T>(int rows, int columns, int valueCount, Int32[] rowPointers, Int32[] columnIndices, T[] values)

    +
    Create a new sparse matrix from a compressed sparse row format. +This new matrix will be independent from the given arrays. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    + + +
    +
    Parameters
    +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowPointers
    +

    The row pointer array of the compressed sparse row format.

    +
    Int32[] columnIndices
    +

    The column index array of the compressed sparse row format.

    +
    T[] values
    +

    The data array of the compressed sparse row format.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The sparse matrix from the compressed sparse row format.

    +
    -
    -

    Matrix<T> SparseDiagonal<T>(int rows, int columns, Func<int, T> init)

    -
    Create a new diagonal sparse matrix and initialize each diagonal value using the provided init function. +
    +

    Matrix<T> SparseFromCoordinateFormat<T>(int rows, int columns, int valueCount, Int32[] rowIndices, Int32[] columnIndices, T[] values)

    +
    Create a new sparse matrix from a coordinate format. +This new matrix will be independent from the given arrays. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    +
    +
    Parameters
    + +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowIndices
    +

    The row index array of the coordinate format.

    +
    Int32[] columnIndices
    +

    The column index array of the coordinate format.

    +
    T[] values
    +

    The data array of the coordinate format.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The sparse matrix from the coordinate format.

    +
    -

    Matrix<T> SparseIdentity<T>(int order)

    +

    Matrix<T> SparseIdentity<T>(int rows, int columns)

    Create a new diagonal dense identity matrix with a one-diagonal. @@ -901,7 +1004,7 @@ storage for performance or interop reasons.
    -

    Matrix<T> SparseIdentity<T>(int rows, int columns)

    +

    Matrix<T> SparseIdentity<T>(int order)

    Create a new diagonal dense identity matrix with a one-diagonal. @@ -995,7 +1098,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> SparseOfDiagonalArray<T>(int rows, int columns, T[] diagonal)

    +

    Matrix<T> SparseOfDiagonalArray<T>(T[] diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -1006,7 +1109,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> SparseOfDiagonalArray<T>(T[] diagonal)

    +

    Matrix<T> SparseOfDiagonalArray<T>(int rows, int columns, T[] diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given array. This new matrix will be independent from the array. A new memory block will be allocated for storing the matrix. @@ -1017,7 +1120,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> SparseOfDiagonalVector<T>(int rows, int columns, Vector<T> diagonal)

    +

    Matrix<T> SparseOfDiagonalVector<T>(Vector<T> diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -1028,7 +1131,7 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> SparseOfDiagonalVector<T>(Vector<T> diagonal)

    +

    Matrix<T> SparseOfDiagonalVector<T>(int rows, int columns, Vector<T> diagonal)

    Create a new sparse matrix with the diagonal as a copy of the given vector. This new matrix will be independent from the vector. A new memory block will be allocated for storing the matrix. @@ -1071,8 +1174,10 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> SparseOfRowArrays<T>(T[][] rows)

    -
    +

    Matrix<T> SparseOfRowArrays<T>(IEnumerable<T[]> rows)

    +
    Create a new sparse matrix as a copy of the given row arrays. +This new matrix will be independent from the arrays. +A new memory block will be allocated for storing the matrix. @@ -1080,10 +1185,8 @@ A new memory block will be allocated for storing the matrix.
    -

    Matrix<T> SparseOfRowArrays<T>(IEnumerable<T[]> rows)

    -
    Create a new sparse matrix as a copy of the given row arrays. -This new matrix will be independent from the arrays. -A new memory block will be allocated for storing the matrix. +

    Matrix<T> SparseOfRowArrays<T>(T[][] rows)

    +
    @@ -1159,7 +1262,7 @@ If you have an instance of a discrete storage type instead, use their direct met diff --git a/api/MathNet.Numerics.LinearAlgebra/CreateVector.htm b/api/MathNet.Numerics.LinearAlgebra/CreateVector.htm index 50ceadf4..87b499bc 100644 --- a/api/MathNet.Numerics.LinearAlgebra/CreateVector.htm +++ b/api/MathNet.Numerics.LinearAlgebra/CreateVector.htm @@ -492,7 +492,7 @@ If you have an instance of a discrete storage type instead, use their direct met diff --git a/api/MathNet.Numerics.LinearAlgebra/ExistingData.htm b/api/MathNet.Numerics.LinearAlgebra/ExistingData.htm index 9e185d2c..5eccc55f 100644 --- a/api/MathNet.Numerics.LinearAlgebra/ExistingData.htm +++ b/api/MathNet.Numerics.LinearAlgebra/ExistingData.htm @@ -338,7 +338,7 @@ clearing it may be skipped if applicable.
    diff --git a/api/MathNet.Numerics.LinearAlgebra/MatrixBuilder`1.htm b/api/MathNet.Numerics.LinearAlgebra/MatrixBuilder`1.htm index 6c0f52a1..e007d20a 100644 --- a/api/MathNet.Numerics.LinearAlgebra/MatrixBuilder`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra/MatrixBuilder`1.htm @@ -319,8 +319,7 @@ Very efficient, but changes to the array and the matrix will affect each other.

    Matrix<T> Dense(int rows, int columns)

    Create a new dense matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -676,8 +675,7 @@ storage for performance or interop reasons.

    Matrix<T> Diagonal(int rows, int columns)

    Create a new diagonal matrix with the given number of rows and columns. -All cells of the matrix will be initialized to zero. -Zero-length matrices are not supported. +All cells of the matrix will be initialized to zero. @@ -911,6 +909,12 @@ Intended for advanced scenarios where you're working directly with storage for performance or interop reasons. +
    +
    Parameters
    + +
    SparseCompressedRowMatrixStorage<T> storage
    +

    The SparseCompressedRowMatrixStorage

    +
    @@ -969,35 +973,104 @@ storage for performance or interop reasons.
    -

    Matrix<T> SparseFromCompressedSparseColumnFormat(int rows, int columns, int nonZeroCount, Int32[] cscRowIndices, Int32[] cscColumnPointers, T[] cscValues)

    +

    Matrix<T> SparseFromCompressedSparseColumnFormat(int rows, int columns, int valueCount, Int32[] rowIndices, Int32[] columnPointers, T[] values)

    Create a new sparse matrix from a compressed sparse column format. This new matrix will be independent from the given arrays. -A new memory block will be allocated for storing the matrix. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    +
    +
    Parameters
    +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowIndices
    +

    The row index array of the compressed sparse column format.

    +
    Int32[] columnPointers
    +

    The column pointer array of the compressed sparse column format.

    +
    T[] values
    +

    The data array of the compressed sparse column format.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The sparse matrix from the compressed sparse column format.

    +
    -

    Matrix<T> SparseFromCompressedSparseRowFormat(int rows, int columns, int nonZeroCount, Int32[] csrRowPointers, Int32[] csrColumnIndices, T[] csrValues)

    +

    Matrix<T> SparseFromCompressedSparseRowFormat(int rows, int columns, int valueCount, Int32[] rowPointers, Int32[] columnIndices, T[] values)

    Create a new sparse matrix from a compressed sparse row format. This new matrix will be independent from the given arrays. -A new memory block will be allocated for storing the matrix. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    +
    +
    Parameters
    + +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowPointers
    +

    The row pointer array of the compressed sparse row format.

    +
    Int32[] columnIndices
    +

    The column index array of the compressed sparse row format.

    +
    T[] values
    +

    The data array of the compressed sparse row format.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The sparse matrix from the compressed sparse row format.

    +
    -

    Matrix<T> SparseFromCoordinateFormat(int rows, int columns, int nonZeroCount, Int32[] cooRowIndices, Int32[] cooColumnIndices, T[] cooValues)

    +

    Matrix<T> SparseFromCoordinateFormat(int rows, int columns, int valueCount, Int32[] rowIndices, Int32[] columnIndices, T[] values)

    Create a new sparse matrix from a coordinate format. This new matrix will be independent from the given arrays. -A new memory block will be allocated for storing the matrix. +A new memory block will be allocated for storing the matrix.
    + Duplicate entries will be summed together and explicit zeros will be not intentionally removed. +
    +
    +
    Parameters
    + +
    int rows
    +

    The number of rows.

    +
    int columns
    +

    The number of columns.

    +
    int valueCount
    +

    The number of stored values including explicit zeros.

    +
    Int32[] rowIndices
    +

    The row index array of the coordinate format.

    +
    Int32[] columnIndices
    +

    The column index array of the coordinate format.

    +
    T[] values
    +

    The data array of the coordinate format.

    +
    +
    +
    Return
    +
    Matrix<T>
    +

    The sparse matrix from the coordinate format.

    +
    @@ -1281,7 +1354,7 @@ A new memory block will be allocated for storing the matrix.
    diff --git a/api/MathNet.Numerics.LinearAlgebra/MatrixExtensions.htm b/api/MathNet.Numerics.LinearAlgebra/MatrixExtensions.htm index 5212f76a..07215ee0 100644 --- a/api/MathNet.Numerics.LinearAlgebra/MatrixExtensions.htm +++ b/api/MathNet.Numerics.LinearAlgebra/MatrixExtensions.htm @@ -245,7 +245,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra/Matrix`1.htm b/api/MathNet.Numerics.LinearAlgebra/Matrix`1.htm index a78e38c6..86863ab9 100644 --- a/api/MathNet.Numerics.LinearAlgebra/Matrix`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra/Matrix`1.htm @@ -398,6 +398,7 @@
  • RemainderByThis
  • RemoveColumn
  • RemoveRow
    • +
  • Resize
  • Row
  • Row
  • Row
    • @@ -1071,29 +1072,28 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    -
    Copies the requested column elements into the given vector. +

    Vector<T> Column(int index)

    +
    Copies a column into a new Vector>.
    Parameters
    -
    int columnIndex
    -

    The column to copy elements from.

    -
    int rowIndex
    -

    The row to start copying from.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    int index
    +

    The column to copy.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the copied elements.

    +
    -

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    -
    Copies the requested column elements into a new Vector. +

    void Column(int columnIndex, int rowIndex, int length, Vector<T> result)

    +
    Copies the requested column elements into the given vector.
    @@ -1105,13 +1105,10 @@ Use ToRowMajorArray instead if you always need an independent array.

    The row to start copying from.

    int length

    The number of elements to copy.

    +
    Vector<T> result
    +

    The Vector to copy the column into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the requested elements.

    -
    @@ -1133,21 +1130,25 @@ Use ToRowMajorArray instead if you always need an independent array.
    -

    Vector<T> Column(int index)

    -
    Copies a column into a new Vector>. +

    Vector<T> Column(int columnIndex, int rowIndex, int length)

    +
    Copies the requested column elements into a new Vector.
    Parameters
    -
    int index
    -

    The column to copy.

    +
    int columnIndex
    +

    The column to copy elements from.

    +
    int rowIndex
    +

    The row to start copying from.

    +
    int length
    +

    The number of elements to copy.

    Return
    Vector<T>
    -

    A Vector containing the copied elements.

    +

    A Vector containing the requested elements.

    @@ -1223,15 +1224,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -
    -
    -
    -

    void ConjugateTranspose(Matrix<T> result)

    -
    Puts the conjugate transpose of this matrix into the result matrix. - - - -
    @@ -1246,6 +1238,15 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and

    The conjugate transpose of this matrix.

    +
    +
    +
    +

    void ConjugateTranspose(Matrix<T> result)

    +
    Puts the conjugate transpose of this matrix into the result matrix. + + + +
    @@ -1286,8 +1287,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix. +

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result.
    @@ -1295,10 +1296,13 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the multiplication.

    +
    @@ -1323,36 +1327,33 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> ConjugateTransposeThisAndMultiply(Matrix<T> other)

    -
    Multiplies the conjugate transpose of this matrix with another matrix and returns the result. +

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    +
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    -

    void ConjugateTransposeThisAndMultiply(Vector<T> rightSide, Vector<T> result)

    -
    Multiplies the conjugate transpose of this matrix with a vector and places the results into the result vector. +

    void ConjugateTransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the conjugate transpose of this matrix with another matrix and places the results into the result matrix.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result

    The result of the multiplication.

    @@ -1403,23 +1404,6 @@ i == j (i is the row index, and j is the column index).

    The elements of the diagonal.

    -
    -
    -
    -

    void DiagonalStack(Matrix<T> lower, Matrix<T> result)

    -
    Diagonally stacks his matrix on top of the given matrix and places the combined matrix into the result matrix. - - -
    -
    Parameters
    - -
    Matrix<T> lower
    -

    The lower, right matrix.

    -
    Matrix<T> result
    -

    The combined matrix

    -
    - -
    @@ -1444,18 +1428,18 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -
    -

    void Divide(T scalar, Matrix<T> result)

    -
    Divides each element of the matrix by a scalar and places results into the result matrix. +
    +

    void DiagonalStack(Matrix<T> lower, Matrix<T> result)

    +
    Diagonally stacks his matrix on top of the given matrix and places the combined matrix into the result matrix.
    Parameters
    -
    T scalar
    -

    The scalar to divide the matrix with.

    +
    Matrix<T> lower
    +

    The lower, right matrix.

    Matrix<T> result
    -

    The matrix to store the result of the division.

    +

    The combined matrix

    @@ -1481,23 +1465,20 @@ The values of off the off diagonal matrices/blocks are set to zero.
    -
    -

    Matrix<T> DivideByThis(T scalar)

    -
    Divides a scalar by each element of the matrix. +
    +

    void Divide(T scalar, Matrix<T> result)

    +
    Divides each element of the matrix by a scalar and places results into the result matrix.
    Parameters
    T scalar
    -

    The scalar to divide.

    +

    The scalar to divide the matrix with.

    +
    Matrix<T> result
    +

    The matrix to store the result of the division.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the division.

    -
    @@ -1516,6 +1497,26 @@ The values of off the off diagonal matrices/blocks are set to zero.
    +
    +
    +
    +

    Matrix<T> DivideByThis(T scalar)

    +
    Divides a scalar by each element of the matrix. + + +
    +
    Parameters
    + +
    T scalar
    +

    The scalar to divide.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    The result of the division.

    +
    +
    @@ -1601,7 +1602,7 @@ and the second value being the value of the column at that index.
    -

    IEnumerable<Tuple<int, int, T>> EnumerateIndexed(Zeros zeros)

    +

    IEnumerable<Tuple<int, int, T>> EnumerateIndexed()

    Returns an IEnumerable that can be used to iterate through all values of the matrix and their index.
    The enumerator returns a Tuple with the first two values being the row and column index and the third value being the value of the element at that index. @@ -1614,7 +1615,7 @@ The enumerator will include all values, even if they are zero.
    -

    IEnumerable<Tuple<int, int, T>> EnumerateIndexed()

    +

    IEnumerable<Tuple<int, int, T>> EnumerateIndexed(Zeros zeros)

    Returns an IEnumerable that can be used to iterate through all values of the matrix and their index.
    The enumerator returns a Tuple with the first two values being the row and column index and the third value being the value of the element at that index. @@ -1624,15 +1625,6 @@ The enumerator will include all values, even if they are zero. -
    -
    -
    -

    IEnumerable<Vector<T>> EnumerateRows()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix. - - - -
    @@ -1652,12 +1644,9 @@ The enumerator will include all values, even if they are zero.
    -
    -

    IEnumerable<Tuple<int, Vector<T>>> EnumerateRowsIndexed()

    -
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    - The enumerator returns a Tuple with the first value being the row index -and the second value being the value of the row at that index. -
    +
    +

    IEnumerable<Vector<T>> EnumerateRows()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix. @@ -1682,6 +1671,18 @@ and the second value being the value of the row at that index.
    +
    +
    +
    +

    IEnumerable<Tuple<int, Vector<T>>> EnumerateRowsIndexed()

    +
    Returns an IEnumerable that can be used to iterate through all rows of the matrix and their index.
    + The enumerator returns a Tuple with the first value being the row index +and the second value being the value of the row at that index. +
    + + + +
    @@ -2066,23 +2067,6 @@ In a later release, it will be replaced with a sparse implementation.

    The largest singular value of the matrix.

    -
    -
    -
    -

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    -
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. - - -
    -
    Parameters
    - -
    Vector<T> leftSide
    -

    The vector to multiply with.

    -
    Vector<T> result
    -

    The result of the multiplication.

    -
    - -
    @@ -2105,17 +2089,20 @@ In a later release, it will be replaced with a sparse implementation.
    -
    -

    Matrix<T> LowerTriangle()

    -
    Returns a new matrix containing the lower triangle of this matrix. +
    +

    void LeftMultiply(Vector<T> leftSide, Vector<T> result)

    +
    Left multiply a matrix with a vector ( = vector * matrix ) and place the result in the result vector. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The lower triangle of this matrix.

    +
    Vector<T> leftSide
    +

    The vector to multiply with.

    +
    Vector<T> result
    +

    The result of the multiplication.

    +
    @@ -2132,6 +2119,20 @@ In a later release, it will be replaced with a sparse implementation.
    +
    +
    +
    +

    Matrix<T> LowerTriangle()

    +
    Returns a new matrix containing the lower triangle of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    The lower triangle of this matrix.

    +
    +
    @@ -2171,8 +2172,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Map2(Func<T, T, T> f, Matrix<T> other, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and returns the results as a new vector. +

    void Map2(Func<T, T, T> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and replaces the value in the result vector. @@ -2180,8 +2181,8 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    void Map2(Func<T, T, T> f, Matrix<T> other, Matrix<T> result, Zeros zeros)

    -
    Applies a function to each value pair of two matrices and replaces the value in the result vector. +

    Matrix<T> Map2(Func<T, T, T> f, Matrix<T> other, Zeros zeros)

    +
    Applies a function to each value pair of two matrices and returns the results as a new vector. @@ -2259,7 +2260,7 @@ on the actual data storage implementation (relevant mostly for sparse matrices).
    -

    Matrix<T> Modulus(T divisor)

    +

    void Modulus(T divisor, Matrix<T> result)

    Computes the canonical modulus, where the result has the sign of the divisor, for each element of the matrix. @@ -2269,18 +2270,15 @@ for each element of the matrix.
    T divisor

    The scalar denominator to use.

    +
    Matrix<T> result
    +

    Matrix to store the results in.

    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the results.

    -
    -

    void Modulus(T divisor, Matrix<T> result)

    +

    Matrix<T> Modulus(T divisor)

    Computes the canonical modulus, where the result has the sign of the divisor, for each element of the matrix. @@ -2290,10 +2288,13 @@ for each element of the matrix.
    T divisor

    The scalar denominator to use.

    -
    Matrix<T> result
    -

    Matrix to store the results in.

    +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the results.

    +
    @@ -2337,20 +2338,20 @@ for each element of the matrix.
    -

    Matrix<T> Multiply(T scalar)

    -
    Multiplies each element of this matrix with a scalar. +

    Vector<T> Multiply(Vector<T> rightSide)

    +
    Multiplies this matrix by a vector and returns the result.
    Parameters
    -
    T scalar
    -

    The scalar to multiply with.

    +
    Vector<T> rightSide
    +

    The vector to multiply with.

    Return
    -
    Matrix<T>
    +
    Vector<T>

    The result of the multiplication.

    @@ -2374,42 +2375,39 @@ for each element of the matrix.
    -

    Vector<T> Multiply(Vector<T> rightSide)

    -
    Multiplies this matrix by a vector and returns the result. +

    Matrix<T> Multiply(Matrix<T> other)

    +
    Multiplies this matrix with another matrix and returns the result.
    Parameters
    -
    Vector<T> rightSide
    -

    The vector to multiply with.

    +
    Matrix<T> other
    +

    The matrix to multiply with.

    Return
    -
    Vector<T>
    +
    Matrix<T>

    The result of the multiplication.

    -

    Matrix<T> Multiply(Matrix<T> other)

    -
    Multiplies this matrix with another matrix and returns the result. +

    void Multiply(T scalar, Matrix<T> result)

    +
    Multiplies each element of the matrix by a scalar and places results into the result matrix.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    +
    T scalar
    +

    The scalar to multiply the matrix with.

    +
    Matrix<T> result
    +

    The matrix to store the result of the multiplication.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the multiplication.

    -
    @@ -2431,32 +2429,21 @@ for each element of the matrix.
    -

    void Multiply(T scalar, Matrix<T> result)

    -
    Multiplies each element of the matrix by a scalar and places results into the result matrix. +

    Matrix<T> Multiply(T scalar)

    +
    Multiplies each element of this matrix with a scalar.
    Parameters
    T scalar
    -

    The scalar to multiply the matrix with.

    -
    Matrix<T> result
    -

    The matrix to store the result of the multiplication.

    +

    The scalar to multiply with.

    - -
    -
    -
    -

    Matrix<T> Negate()

    -
    Negate each element of this matrix. - - -
    Return
    Matrix<T>
    -

    A matrix containing the negated values.

    +

    The result of the multiplication.

    @@ -2474,6 +2461,20 @@ for each element of the matrix.
    +
    +
    +
    +

    Matrix<T> Negate()

    +
    Negate each element of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the negated values.

    +
    +
    @@ -2541,95 +2542,95 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAbs()

    +

    void PointwiseAbs(Matrix<T> result)

    Pointwise applies the abs function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseAbs(Matrix<T> result)

    +

    Matrix<T> PointwiseAbs()

    Pointwise applies the abs function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    void PointwiseAbsoluteMaximum(T scalar, Matrix<T> result)

    -
    Pointwise applies the absolute maximum with a scalar to each value. +

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    +
    Pointwise applies the absolute maximum with the values of another matrix to each value.
    Parameters
    -
    T scalar
    -

    The scalar value to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    -

    Matrix<T> PointwiseAbsoluteMaximum(T scalar)

    -
    Pointwise applies the absolute maximum with a scalar to each value. +

    void PointwiseAbsoluteMaximum(Matrix<T> other, Matrix<T> result)

    +
    Pointwise applies the absolute maximum with the values of another matrix to each value.
    Parameters
    -
    T scalar
    -

    The scalar value to compare to.

    +
    Matrix<T> other
    +

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    Matrix<T> PointwiseAbsoluteMaximum(Matrix<T> other)

    -
    Pointwise applies the absolute maximum with the values of another matrix to each value. +

    void PointwiseAbsoluteMaximum(T scalar, Matrix<T> result)

    +
    Pointwise applies the absolute maximum with a scalar to each value.
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    +
    T scalar
    +

    The scalar value to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -

    void PointwiseAbsoluteMaximum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the absolute maximum with the values of another matrix to each value. +

    Matrix<T> PointwiseAbsoluteMaximum(T scalar)

    +
    Pointwise applies the absolute maximum with a scalar to each value.
    Parameters
    -
    Matrix<T> other
    -

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    +
    T scalar
    +

    The scalar value to compare to.

    -

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    +

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2638,6 +2639,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    @@ -2676,7 +2679,7 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void PointwiseAbsoluteMinimum(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> PointwiseAbsoluteMinimum(Matrix<T> other)

    Pointwise applies the absolute minimum with the values of another matrix to each value. @@ -2685,8 +2688,6 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    Matrix<T> other

    The matrix with the values to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    @@ -2741,25 +2742,25 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    Matrix<T> PointwiseAtan()

    +

    void PointwiseAtan(Matrix<T> result)

    Pointwise applies the atan function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseAtan(Matrix<T> result)

    +

    Matrix<T> PointwiseAtan()

    Pointwise applies the atan function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -2795,25 +2796,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    void PointwiseCeiling(Matrix<T> result)

    +

    Matrix<T> PointwiseCeiling()

    Pointwise applies the ceiling function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseCeiling()

    +

    void PointwiseCeiling(Matrix<T> result)

    Pointwise applies the ceiling function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -2843,25 +2844,25 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseCosh()

    +

    void PointwiseCosh(Matrix<T> result)

    Pointwise applies the cosh function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseCosh(Matrix<T> result)

    +

    Matrix<T> PointwiseCosh()

    Pointwise applies the cosh function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -2901,6 +2902,15 @@ matrix and a given other matrix being the 'x' of atan2 and the

    A new matrix that is the pointwise division of this matrix and divisor.

    +
    +
    +
    +

    Matrix<T> PointwiseExp()

    +
    Pointwise applies the exponent function to each value. + + + +
    @@ -2918,9 +2928,9 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    Matrix<T> PointwiseExp()

    -
    Pointwise applies the exponent function to each value. +
    +

    Matrix<T> PointwiseFloor()

    +
    Pointwise applies the floor function to each value @@ -2940,15 +2950,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    Matrix<T> PointwiseFloor()

    -
    Pointwise applies the floor function to each value - - - -
    @@ -2973,15 +2974,6 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -
    -
    -

    Matrix<T> PointwiseLog10()

    -
    Pointwise applies the log10 function to each value - - - -
    @@ -2999,19 +2991,11 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -
    -

    void PointwiseMaximum(T scalar, Matrix<T> result)

    -
    Pointwise applies the maximum with a scalar to each value. - +
    +

    Matrix<T> PointwiseLog10()

    +
    Pointwise applies the log10 function to each value -
    -
    Parameters
    -
    T scalar
    -

    The scalar value to compare to.

    -
    Matrix<T> result
    -

    The matrix to store the result.

    -
    @@ -3049,7 +3033,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMaximum(T scalar)

    +

    void PointwiseMaximum(T scalar, Matrix<T> result)

    Pointwise applies the maximum with a scalar to each value. @@ -3058,14 +3042,16 @@ matrix and a given other matrix being the 'x' of atan2 and the
    T scalar

    The scalar value to compare to.

    +
    Matrix<T> result
    +

    The matrix to store the result.

    -
    -

    void PointwiseMinimum(T scalar, Matrix<T> result)

    -
    Pointwise applies the minimum with a scalar to each value. +
    +

    Matrix<T> PointwiseMaximum(T scalar)

    +
    Pointwise applies the maximum with a scalar to each value.
    @@ -3073,17 +3059,30 @@ matrix and a given other matrix being the 'x' of atan2 and the
    T scalar

    The scalar value to compare to.

    -
    Matrix<T> result
    -

    The vector to store the result.

    -

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    -
    Pointwise applies the minimum with the values of another matrix to each value. - +

    Matrix<T> PointwiseMinimum(T scalar)

    +
    Pointwise applies the minimum with a scalar to each value. + + +
    +
    Parameters
    + +
    T scalar
    +

    The scalar value to compare to.

    +
    + + +
    +
    +
    +

    void PointwiseMinimum(Matrix<T> other, Matrix<T> result)

    +
    Pointwise applies the minimum with the values of another matrix to each value. +
    Parameters
    @@ -3113,7 +3112,7 @@ matrix and a given other matrix being the 'x' of atan2 and the
    -

    Matrix<T> PointwiseMinimum(T scalar)

    +

    void PointwiseMinimum(T scalar, Matrix<T> result)

    Pointwise applies the minimum with a scalar to each value. @@ -3122,6 +3121,8 @@ matrix and a given other matrix being the 'x' of atan2 and the
    T scalar

    The scalar value to compare to.

    +
    Matrix<T> result
    +

    The vector to store the result.

    @@ -3159,26 +3160,6 @@ of this matrix by another matrix and stores the result into the result matrix.
    -
    -
    -
    -

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    -
    Pointwise multiplies this matrix with another matrix. - - -
    -
    Parameters
    - -
    Matrix<T> other
    -

    The matrix to pointwise multiply with this one.

    -
    - -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix that is the pointwise multiplication of this matrix and other.

    -
    -
    @@ -3198,18 +3179,23 @@ of this matrix by another matrix and stores the result into the result matrix.
    -
    -

    Matrix<T> PointwisePower(T exponent)

    -
    Pointwise raise this matrix to an exponent and store the result into the result matrix. +
    +

    Matrix<T> PointwiseMultiply(Matrix<T> other)

    +
    Pointwise multiplies this matrix with another matrix.
    Parameters
    -
    T exponent
    -

    The exponent to raise this matrix values to.

    +
    Matrix<T> other
    +

    The matrix to pointwise multiply with this one.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix that is the pointwise multiplication of this matrix and other.

    +
    @@ -3262,19 +3248,16 @@ of this matrix by another matrix and stores the result into the result matrix.
    -
    -

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    -
    Pointwise remainder (% operator), where the result has the sign of the dividend, -of this matrix by another matrix and stores the result into the result matrix. +
    +

    Matrix<T> PointwisePower(T exponent)

    +
    Pointwise raise this matrix to an exponent and store the result into the result matrix.
    Parameters
    -
    Matrix<T> divisor
    -

    The pointwise denominator matrix to use.

    -
    Matrix<T> result
    -

    The matrix to store the result of the pointwise remainder.

    +
    T exponent
    +

    The exponent to raise this matrix values to.

    @@ -3296,16 +3279,19 @@ of this matrix by another matrix.
    -
    -

    void PointwiseRound(Matrix<T> result)

    -
    Pointwise applies the round function to each value +
    +

    void PointwiseRemainder(Matrix<T> divisor, Matrix<T> result)

    +
    Pointwise remainder (% operator), where the result has the sign of the dividend, +of this matrix by another matrix and stores the result into the result matrix.
    Parameters
    +
    Matrix<T> divisor
    +

    The pointwise denominator matrix to use.

    Matrix<T> result
    -

    The vector to store the result

    +

    The matrix to store the result of the pointwise remainder.

    @@ -3318,6 +3304,21 @@ of this matrix by another matrix. +
    +
    +
    +

    void PointwiseRound(Matrix<T> result)

    +
    Pointwise applies the round function to each value + + +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    + +
    @@ -3345,25 +3346,25 @@ of this matrix by another matrix.
    -

    Matrix<T> PointwiseSin()

    +

    void PointwiseSin(Matrix<T> result)

    Pointwise applies the sin function to each value +
    +
    Parameters
    + +
    Matrix<T> result
    +

    The vector to store the result

    +
    -

    void PointwiseSin(Matrix<T> result)

    +

    Matrix<T> PointwiseSin()

    Pointwise applies the sin function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    @@ -3393,34 +3394,25 @@ of this matrix by another matrix.
    -

    void PointwiseSqrt(Matrix<T> result)

    +

    Matrix<T> PointwiseSqrt()

    Pointwise applies the sqrt function to each value -
    -
    Parameters
    - -
    Matrix<T> result
    -

    The vector to store the result

    -
    -

    Matrix<T> PointwiseSqrt()

    +

    void PointwiseSqrt(Matrix<T> result)

    Pointwise applies the sqrt function to each value +
    +
    Parameters
    - -
    -
    -
    -

    Matrix<T> PointwiseTan()

    -
    Pointwise applies the tan function to each value - - +
    Matrix<T> result
    +

    The vector to store the result

    +
    @@ -3440,9 +3432,9 @@ of this matrix by another matrix.
    -
    -

    Matrix<T> PointwiseTanh()

    -
    Pointwise applies the tanh function to each value +
    +

    Matrix<T> PointwiseTan()

    +
    Pointwise applies the tan function to each value @@ -3462,6 +3454,15 @@ of this matrix by another matrix.
    +
    +
    +
    +

    Matrix<T> PointwiseTanh()

    +
    Pointwise applies the tanh function to each value + + + +
    @@ -3568,7 +3569,7 @@ also known as the range or image of the corresponding matrix transformation.
    -

    Matrix<T> Remainder(T divisor)

    +

    void Remainder(T divisor, Matrix<T> result)

    Computes the remainder (matrix % divisor), where the result has the sign of the dividend, for each element of the matrix. @@ -3578,18 +3579,15 @@ for each element of the matrix.
    T divisor

    The scalar denominator to use.

    +
    Matrix<T> result
    +

    Matrix to store the results in.

    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the results.

    -
    -

    void Remainder(T divisor, Matrix<T> result)

    +

    Matrix<T> Remainder(T divisor)

    Computes the remainder (matrix % divisor), where the result has the sign of the dividend, for each element of the matrix. @@ -3599,15 +3597,18 @@ for each element of the matrix.
    T divisor

    The scalar denominator to use.

    -
    Matrix<T> result
    -

    Matrix to store the results in.

    +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the results.

    +
    -

    void RemainderByThis(T dividend, Matrix<T> result)

    +

    Matrix<T> RemainderByThis(T dividend)

    Computes the remainder (dividend % matrix), where the result has the sign of the dividend, for each element of the matrix. @@ -3617,15 +3618,18 @@ for each element of the matrix.
    T dividend

    The scalar numerator to use.

    -
    Matrix<T> result
    -

    Matrix to store the results in.

    +
    +
    Return
    +
    Matrix<T>
    +

    A matrix containing the results.

    +
    -

    Matrix<T> RemainderByThis(T dividend)

    +

    void RemainderByThis(T dividend, Matrix<T> result)

    Computes the remainder (dividend % matrix), where the result has the sign of the dividend, for each element of the matrix. @@ -3635,13 +3639,10 @@ for each element of the matrix.
    T dividend

    The scalar numerator to use.

    +
    Matrix<T> result
    +

    Matrix to store the results in.

    -
    -
    Return
    -
    Matrix<T>
    -

    A matrix containing the results.

    -
    @@ -3683,10 +3684,33 @@ for each element of the matrix.

    A new matrix without the chosen row.

    +
    +
    +
    +

    Matrix<T> Resize(int rowCount, int columnCount)

    +
    Creates a new matrix with the desired size and copies this matrix to it. +Values which no longer exist in the new matrix are ignored, new values are set to zero. + + +
    +
    Parameters
    + +
    int rowCount
    +

    The number of rows of the new matrix.

    +
    int columnCount
    +

    The number of columns of the new matrix.

    +
    + +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix with the desired rows and columns.

    +
    +
    -

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    +

    Vector<T> Row(int rowIndex, int columnIndex, int length)

    Copies the requested row elements into a new Vector. @@ -3699,33 +3723,40 @@ for each element of the matrix.

    The column to start copying from.

    int length

    The number of elements to copy.

    -
    Vector<T> result
    -

    The Vector to copy the column into.

    +
    +
    Return
    +
    Vector<T>
    +

    A Vector containing the requested elements.

    +
    -

    void Row(int index, Vector<T> result)

    -
    Copies a row into to the given Vector. +

    void Row(int rowIndex, int columnIndex, int length, Vector<T> result)

    +
    Copies the requested row elements into a new Vector.
    Parameters
    -
    int index
    -

    The row to copy.

    +
    int rowIndex
    +

    The row to copy elements from.

    +
    int columnIndex
    +

    The column to start copying from.

    +
    int length
    +

    The number of elements to copy.

    Vector<T> result
    -

    The Vector to copy the row into.

    +

    The Vector to copy the column into.

    -

    Vector<T> Row(int index)

    -
    Copies a row into an Vector. +

    void Row(int index, Vector<T> result)

    +
    Copies a row into to the given Vector.
    @@ -3733,36 +3764,29 @@ for each element of the matrix.
    int index

    The row to copy.

    +
    Vector<T> result
    +

    The Vector to copy the row into.

    -
    -
    Return
    -
    Vector<T>
    -

    A Vector containing the copied elements.

    -
    -

    Vector<T> Row(int rowIndex, int columnIndex, int length)

    -
    Copies the requested row elements into a new Vector. +

    Vector<T> Row(int index)

    +
    Copies a row into an Vector.
    Parameters
    -
    int rowIndex
    -

    The row to copy elements from.

    -
    int columnIndex
    -

    The column to start copying from.

    -
    int length
    -

    The number of elements to copy.

    +
    int index
    +

    The row to copy.

    Return
    Vector<T>
    -

    A Vector containing the requested elements.

    +

    A Vector containing the copied elements.

    @@ -3851,8 +3875,8 @@ Typical values for p are 1.0 (L1, Manhattan norm), 2.0 (L2, Euclidean norm) and
    -

    void SetDiagonal(Vector<T> source)

    -
    Copies the values of the given Vector to the diagonal.
    +

    void SetDiagonal(T[] source)

    +
    Copies the values of the given array to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3861,8 +3885,8 @@ this[i,i].
    Parameters
    -
    Vector<T> source
    -

    The vector to copy the values from. The length of the vector should be +

    T[] source
    +

    The array to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3870,8 +3894,8 @@ Min(Rows, Columns).

    -

    void SetDiagonal(T[] source)

    -
    Copies the values of the given array to the diagonal.
    +

    void SetDiagonal(Vector<T> source)

    +
    Copies the values of the given Vector to the diagonal.
    For non-square matrices, the elements of source are copied to this[i,i].
    @@ -3880,8 +3904,8 @@ this[i,i].
    Parameters
    -
    T[] source
    -

    The array to copy the values from. The length of the vector should be +

    Vector<T> source
    +

    The vector to copy the values from. The length of the vector should be Min(Rows, Columns).

    @@ -3889,8 +3913,8 @@ Min(Rows, Columns).

    -

    void SetRow(int rowIndex, T[] row)

    -
    Copies the values of the given array to the specified row. +

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    +
    Copies the values of the given Vector to the specified sub-row.
    @@ -3898,16 +3922,20 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    T[] row
    -

    The array to copy the values from.

    +
    int columnIndex
    +

    The column to start copying to.

    +
    int length
    +

    The number of elements to copy.

    +
    Vector<T> row
    +

    The vector to copy the values from.

    -

    void SetRow(int rowIndex, int columnIndex, int length, Vector<T> row)

    -
    Copies the values of the given Vector to the specified sub-row. +

    void SetRow(int rowIndex, T[] row)

    +
    Copies the values of the given array to the specified row.
    @@ -3915,12 +3943,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to copy the values to.

    -
    int columnIndex
    -

    The column to start copying to.

    -
    int length
    -

    The number of elements to copy.

    -
    Vector<T> row
    -

    The vector to copy the values from.

    +
    T[] row
    +

    The array to copy the values from.

    @@ -3944,7 +3968,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3953,8 +3977,16 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    +
    int sorceRowIndex
    +

    The row of the sub-matrix to start copying from.

    +
    int rowCount
    +

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    +
    int sourceColumnIndex
    +

    The column of the sub-matrix to start copying from.

    +
    int columnCount
    +

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -3986,7 +4018,7 @@ Min(Rows, Columns).

    -

    void SetSubMatrix(int rowIndex, int sorceRowIndex, int rowCount, int columnIndex, int sourceColumnIndex, int columnCount, Matrix<T> subMatrix)

    +

    void SetSubMatrix(int rowIndex, int columnIndex, Matrix<T> subMatrix)

    Copies the values of a given matrix into a region in this matrix. @@ -3995,16 +4027,8 @@ Min(Rows, Columns).

    int rowIndex

    The row to start copying to.

    -
    int sorceRowIndex
    -

    The row of the sub-matrix to start copying from.

    -
    int rowCount
    -

    The number of rows to copy. Must be positive.

    int columnIndex

    The column to start copying to.

    -
    int sourceColumnIndex
    -

    The column of the sub-matrix to start copying from.

    -
    int columnCount
    -

    The number of columns to copy. Must be positive.

    Matrix<T> subMatrix

    The sub-matrix to copy from.

    @@ -4013,27 +4037,27 @@ Min(Rows, Columns).

    -

    Matrix<T> Solve(Matrix<T> input)

    +

    Vector<T> Solve(Vector<T> input)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Matrix<T> input
    -

    The right hand side Matrix`1 , .

    +
    Vector<T> input
    +

    The right hand side vector, .

    Return
    -
    Matrix<T>
    -

    The left hand side Matrix`1 , .

    +
    Vector<T>
    +

    The left hand side Vector`1 , .

    -

    void Solve(Matrix<T> input, Matrix<T> result)

    +

    Matrix<T> Solve(Matrix<T> input)

    Solves a system of linear equations, , with A QR factorized. @@ -4042,30 +4066,30 @@ Min(Rows, Columns).

    Matrix<T> input

    The right hand side Matrix`1 , .

    -
    Matrix<T> result
    -

    The left hand side Matrix`1 , .

    +
    +
    Return
    +
    Matrix<T>
    +

    The left hand side Matrix`1 , .

    +
    -

    Vector<T> Solve(Vector<T> input)

    +

    void Solve(Matrix<T> input, Matrix<T> result)

    Solves a system of linear equations, , with A QR factorized.
    Parameters
    -
    Vector<T> input
    -

    The right hand side vector, .

    +
    Matrix<T> input
    +

    The right hand side Matrix`1 , .

    +
    Matrix<T> result
    +

    The left hand side Matrix`1 , .

    -
    -
    Return
    -
    Vector<T>
    -

    The left hand side Vector`1 , .

    -
    @@ -4084,41 +4108,6 @@ Min(Rows, Columns).

    -
    -
    -
    -

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - - -
    -
    -
    -

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. - - -
    -
    Parameters
    - -
    Vector<T> input
    -

    The solution vector b.

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    - -
    -
    Return
    -
    Vector<T>
    -

    The result vector x.

    -
    -
    @@ -4163,6 +4152,41 @@ Min(Rows, Columns).

    +
    +
    +
    +

    Matrix<T> SolveIterative(Matrix<T> input, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    + + + + +
    +
    +
    +

    Vector<T> SolveIterative(Vector<T> input, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation Ax = b, where A is the coefficient matrix (this matrix), b is the solution vector and x is the unknown vector. + + +
    +
    Parameters
    + +
    Vector<T> input
    +

    The solution vector b.

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    + +
    +
    Return
    +
    Vector<T>
    +

    The result vector x.

    +
    +
    @@ -4242,32 +4266,32 @@ does not contain the diagonal elements of this matrix.
    -

    void StrictlyUpperTriangle(Matrix<T> result)

    -
    Puts the strictly upper triangle of this matrix into the result matrix. +

    Matrix<T> StrictlyUpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. The new matrix +does not contain the diagonal elements of this matrix. -
    -
    Parameters
    -
    Matrix<T> result
    -

    Where to store the lower triangle.

    +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    -
    -

    Matrix<T> StrictlyUpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. The new matrix -does not contain the diagonal elements of this matrix. +

    void StrictlyUpperTriangle(Matrix<T> result)

    +
    Puts the strictly upper triangle of this matrix into the result matrix. +
    +
    Parameters
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    +
    Matrix<T> result
    +

    Where to store the lower triangle.

    +
    @@ -4298,15 +4322,15 @@ does not contain the diagonal elements of this matrix.
    -

    void Subtract(T scalar, Matrix<T> result)

    -
    Subtracts a scalar from each element of the matrix and stores the result in the result matrix. +

    void Subtract(Matrix<T> other, Matrix<T> result)

    +
    Subtracts another matrix from this matrix.
    Parameters
    -
    T scalar
    -

    The scalar to subtract.

    +
    Matrix<T> other
    +

    The matrix to subtract.

    Matrix<T> result

    The matrix to store the result of the subtraction.

    @@ -4335,27 +4359,24 @@ does not contain the diagonal elements of this matrix.
    -

    Matrix<T> Subtract(Matrix<T> other)

    -
    Subtracts another matrix from this matrix. +

    void Subtract(T scalar, Matrix<T> result)

    +
    Subtracts a scalar from each element of the matrix and stores the result in the result matrix.
    Parameters
    -
    Matrix<T> other
    -

    The matrix to subtract.

    +
    T scalar
    +

    The scalar to subtract.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    -
    -
    Return
    -
    Matrix<T>
    -

    The result of the subtraction.

    -
    -

    void Subtract(Matrix<T> other, Matrix<T> result)

    +

    Matrix<T> Subtract(Matrix<T> other)

    Subtracts another matrix from this matrix. @@ -4364,16 +4385,19 @@ does not contain the diagonal elements of this matrix.
    Matrix<T> other

    The matrix to subtract.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    +
    +
    Return
    +
    Matrix<T>
    +

    The result of the subtraction.

    +
    -

    void SubtractFrom(T scalar, Matrix<T> result)

    -
    Subtracts each element of the matrix from a scalar and stores the result in the result matrix. +

    Matrix<T> SubtractFrom(T scalar)

    +
    Subtracts each element of the matrix from a scalar.
    @@ -4381,16 +4405,19 @@ does not contain the diagonal elements of this matrix.
    T scalar

    The scalar to subtract from.

    -
    Matrix<T> result
    -

    The matrix to store the result of the subtraction.

    +
    +
    Return
    +
    Matrix<T>
    +

    A new matrix containing the subtraction of the scalar and this matrix.

    +
    -

    Matrix<T> SubtractFrom(T scalar)

    -
    Subtracts each element of the matrix from a scalar. +

    void SubtractFrom(T scalar, Matrix<T> result)

    +
    Subtracts each element of the matrix from a scalar and stores the result in the result matrix.
    @@ -4398,13 +4425,10 @@ does not contain the diagonal elements of this matrix.
    T scalar

    The scalar to subtract from.

    +
    Matrix<T> result
    +

    The matrix to store the result of the subtraction.

    -
    -
    Return
    -
    Matrix<T>
    -

    A new matrix containing the subtraction of the scalar and this matrix.

    -
    @@ -4472,8 +4496,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    -
    Returns a string that summarizes the content of this matrix. +

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<T, string> formatValue)

    +
    @@ -4481,7 +4505,7 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int minLeftColumns, int rightColumns, int maxWidth, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<T, string> formatValue)

    +

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<T, string> formatValue)

    @@ -4490,8 +4514,8 @@ A new memory block will be allocated for the array.
    -

    string ToMatrixString(int upperRows, int lowerRows, int leftColumns, int rightColumns, string horizontalEllipsis, string verticalEllipsis, string diagonalEllipsis, string columnSeparator, string rowSeparator, Func<T, string> formatValue)

    -
    +

    string ToMatrixString(int maxRows, int maxColumns, string format, IFormatProvider provider)

    +
    Returns a string that summarizes the content of this matrix. @@ -4553,9 +4577,10 @@ A new memory block will be allocated for the array.
    -

    string ToString()

    +

    string ToString(string format, IFormatProvider formatProvider)

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. +The maximum number of cells can be configured in the Control class. +The format string is ignored. @@ -4572,10 +4597,9 @@ The maximum number of cells can be configured in the -

    string ToString(string format, IFormatProvider formatProvider)

    +

    string ToString()

    Returns a string that summarizes this matrix. -The maximum number of cells can be configured in the Control class. -The format string is ignored. +The maximum number of cells can be configured in the Control class. @@ -4603,15 +4627,6 @@ The format string is ignored.

    The trace of this matrix

    -
    -
    -
    -

    void Transpose(Matrix<T> result)

    -
    Puts the transpose of this matrix into the result matrix. - - - -
    @@ -4628,19 +4643,11 @@ The format string is ignored.
    -
    -

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix. - +
    +

    void Transpose(Matrix<T> result)

    +
    Puts the transpose of this matrix into the result matrix. -
    -
    Parameters
    -
    Matrix<T> other
    -

    The matrix to multiply with.

    -
    Matrix<T> result
    -

    The result of the multiplication.

    -
    @@ -4665,9 +4672,9 @@ The format string is ignored.
    -
    -

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    -
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. +
    +

    void TransposeAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies this matrix with transpose of another matrix and places the results into the result matrix.
    @@ -4717,6 +4724,23 @@ The format string is ignored.

    The result of the multiplication.

    +
    +
    +
    +

    void TransposeThisAndMultiply(Matrix<T> other, Matrix<T> result)

    +
    Multiplies the transpose of this matrix with another matrix and places the results into the result matrix. + + +
    +
    Parameters
    + +
    Matrix<T> other
    +

    The matrix to multiply with.

    +
    Matrix<T> result
    +

    The result of the multiplication.

    +
    + +
    @@ -4737,15 +4761,6 @@ The format string is ignored.

    The result of the multiplication.

    -
    -
    -
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    -
    - - - -
    @@ -4772,10 +4787,24 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    -
    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    +
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. +
    +
    Parameters
    + +
    Matrix<T> input
    +

    The solution matrix B.

    +
    Matrix<T> result
    +

    The result matrix X

    +
    IIterativeSolver<T> solver
    +

    The iterative solver to use.

    +
    Iterator<T> iterator
    +

    The iterator to use to control when to stop iterating.

    +
    IPreconditioner<T> preconditioner
    +

    The preconditioner to use for approximations.

    +
    @@ -4790,7 +4819,7 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IPreconditioner<T> preconditioner, IIterationStopCriterion`1[] stopCriteria)

    @@ -4799,39 +4828,20 @@ The format string is ignored.
    -

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, Iterator<T> iterator, IPreconditioner<T> preconditioner)

    -
    Solves the matrix equation AX = B, where A is the coefficient matrix (this matrix), B is the solution matrix and X is the unknown matrix. - +

    IterationStatus TrySolveIterative(Vector<T> input, Vector<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Parameters
    -
    Matrix<T> input
    -

    The solution matrix B.

    -
    Matrix<T> result
    -

    The result matrix X

    -
    IIterativeSolver<T> solver
    -

    The iterative solver to use.

    -
    Iterator<T> iterator
    -

    The iterator to use to control when to stop iterating.

    -
    IPreconditioner<T> preconditioner
    -

    The preconditioner to use for approximations.

    -
    -
    -

    Matrix<T> UpperTriangle()

    -
    Returns a new matrix containing the upper triangle of this matrix. +
    +

    IterationStatus TrySolveIterative(Matrix<T> input, Matrix<T> result, IIterativeSolver<T> solver, IIterationStopCriterion`1[] stopCriteria)

    +
    -
    -
    Return
    -
    Matrix<T>
    -

    The upper triangle of this matrix.

    -
    @@ -4848,6 +4858,20 @@ The format string is ignored.
    +
    +
    +
    +

    Matrix<T> UpperTriangle()

    +
    Returns a new matrix containing the upper triangle of this matrix. + + + +
    +
    Return
    +
    Matrix<T>
    +

    The upper triangle of this matrix.

    +
    +
    @@ -4924,7 +4948,7 @@ The format string is ignored.
    diff --git a/api/MathNet.Numerics.LinearAlgebra/Symmetricity.htm b/api/MathNet.Numerics.LinearAlgebra/Symmetricity.htm index 95e09384..6278f6bd 100644 --- a/api/MathNet.Numerics.LinearAlgebra/Symmetricity.htm +++ b/api/MathNet.Numerics.LinearAlgebra/Symmetricity.htm @@ -362,7 +362,7 @@
    diff --git a/api/MathNet.Numerics.LinearAlgebra/VectorBuilder`1.htm b/api/MathNet.Numerics.LinearAlgebra/VectorBuilder`1.htm index bececa06..47b65b44 100644 --- a/api/MathNet.Numerics.LinearAlgebra/VectorBuilder`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra/VectorBuilder`1.htm @@ -555,7 +555,7 @@ A new memory block will be allocated for storing the vector. diff --git a/api/MathNet.Numerics.LinearAlgebra/VectorExtensions.htm b/api/MathNet.Numerics.LinearAlgebra/VectorExtensions.htm index a9ee7f95..1bb8b888 100644 --- a/api/MathNet.Numerics.LinearAlgebra/VectorExtensions.htm +++ b/api/MathNet.Numerics.LinearAlgebra/VectorExtensions.htm @@ -245,7 +245,7 @@ diff --git a/api/MathNet.Numerics.LinearAlgebra/Vector`1.htm b/api/MathNet.Numerics.LinearAlgebra/Vector`1.htm index f466a3c6..b2b44c05 100644 --- a/api/MathNet.Numerics.LinearAlgebra/Vector`1.htm +++ b/api/MathNet.Numerics.LinearAlgebra/Vector`1.htm @@ -3083,7 +3083,7 @@ The format string is ignored. diff --git a/api/MathNet.Numerics.LinearAlgebra/Zeros.htm b/api/MathNet.Numerics.LinearAlgebra/Zeros.htm index 6ca8d32b..68b1349e 100644 --- a/api/MathNet.Numerics.LinearAlgebra/Zeros.htm +++ b/api/MathNet.Numerics.LinearAlgebra/Zeros.htm @@ -337,7 +337,7 @@ When enumerating sparse matrices this can significantly speed up operations. diff --git a/api/MathNet.Numerics.LinearAlgebra/index.htm b/api/MathNet.Numerics.LinearAlgebra/index.htm index 0e759fe1..10dcf7ea 100644 --- a/api/MathNet.Numerics.LinearAlgebra/index.htm +++ b/api/MathNet.Numerics.LinearAlgebra/index.htm @@ -183,7 +183,7 @@ diff --git a/api/MathNet.Numerics.LinearRegression/DirectRegressionMethod.htm b/api/MathNet.Numerics.LinearRegression/DirectRegressionMethod.htm index c8dfd35a..71cb2e92 100644 --- a/api/MathNet.Numerics.LinearRegression/DirectRegressionMethod.htm +++ b/api/MathNet.Numerics.LinearRegression/DirectRegressionMethod.htm @@ -328,7 +328,7 @@ diff --git a/api/MathNet.Numerics.LinearRegression/MultipleRegression.htm b/api/MathNet.Numerics.LinearRegression/MultipleRegression.htm index 936a6321..5850324e 100644 --- a/api/MathNet.Numerics.LinearRegression/MultipleRegression.htm +++ b/api/MathNet.Numerics.LinearRegression/MultipleRegression.htm @@ -496,7 +496,7 @@ Uses a singular value decomposition and is therefore more numerically stable (es diff --git a/api/MathNet.Numerics.LinearRegression/SimpleRegression.htm b/api/MathNet.Numerics.LinearRegression/SimpleRegression.htm index 4084c82b..2d42e90f 100644 --- a/api/MathNet.Numerics.LinearRegression/SimpleRegression.htm +++ b/api/MathNet.Numerics.LinearRegression/SimpleRegression.htm @@ -240,7 +240,7 @@ where the intercept is zero and b the slope. diff --git a/api/MathNet.Numerics.LinearRegression/WeightedRegression.htm b/api/MathNet.Numerics.LinearRegression/WeightedRegression.htm index d7403152..af6fb380 100644 --- a/api/MathNet.Numerics.LinearRegression/WeightedRegression.htm +++ b/api/MathNet.Numerics.LinearRegression/WeightedRegression.htm @@ -273,7 +273,7 @@ diff --git a/api/MathNet.Numerics.LinearRegression/index.htm b/api/MathNet.Numerics.LinearRegression/index.htm index 32862188..c333f25b 100644 --- a/api/MathNet.Numerics.LinearRegression/index.htm +++ b/api/MathNet.Numerics.LinearRegression/index.htm @@ -155,7 +155,7 @@ diff --git a/api/MathNet.Numerics.OdeSolvers/AdamsBashforth.htm b/api/MathNet.Numerics.OdeSolvers/AdamsBashforth.htm index 297e504c..56babc7e 100644 --- a/api/MathNet.Numerics.OdeSolvers/AdamsBashforth.htm +++ b/api/MathNet.Numerics.OdeSolvers/AdamsBashforth.htm @@ -274,7 +274,7 @@ diff --git a/api/MathNet.Numerics.OdeSolvers/RungeKutta.htm b/api/MathNet.Numerics.OdeSolvers/RungeKutta.htm index 8d33917d..3dba66b2 100644 --- a/api/MathNet.Numerics.OdeSolvers/RungeKutta.htm +++ b/api/MathNet.Numerics.OdeSolvers/RungeKutta.htm @@ -276,7 +276,7 @@ diff --git a/api/MathNet.Numerics.OdeSolvers/index.htm b/api/MathNet.Numerics.OdeSolvers/index.htm index b5ca87eb..719d5a62 100644 --- a/api/MathNet.Numerics.OdeSolvers/index.htm +++ b/api/MathNet.Numerics.OdeSolvers/index.htm @@ -147,7 +147,7 @@ diff --git a/api/MathNet.Numerics.Optimization.LineSearch/LineSearchResult.htm b/api/MathNet.Numerics.Optimization.LineSearch/LineSearchResult.htm index 8fbb2ad3..914b0cde 100644 --- a/api/MathNet.Numerics.Optimization.LineSearch/LineSearchResult.htm +++ b/api/MathNet.Numerics.Optimization.LineSearch/LineSearchResult.htm @@ -260,7 +260,7 @@ diff --git a/api/MathNet.Numerics.Optimization.LineSearch/StrongWolfeLineSearch.htm b/api/MathNet.Numerics.Optimization.LineSearch/StrongWolfeLineSearch.htm index 75733a75..33e8433f 100644 --- a/api/MathNet.Numerics.Optimization.LineSearch/StrongWolfeLineSearch.htm +++ b/api/MathNet.Numerics.Optimization.LineSearch/StrongWolfeLineSearch.htm @@ -262,7 +262,7 @@ diff --git a/api/MathNet.Numerics.Optimization.LineSearch/WeakWolfeLineSearch.htm b/api/MathNet.Numerics.Optimization.LineSearch/WeakWolfeLineSearch.htm index 3d5a0b28..0d556f82 100644 --- a/api/MathNet.Numerics.Optimization.LineSearch/WeakWolfeLineSearch.htm +++ b/api/MathNet.Numerics.Optimization.LineSearch/WeakWolfeLineSearch.htm @@ -272,7 +272,7 @@ http://www.math.washington.edu/~burke/crs/408/lectures/L9-weak-Wolfe.pdf diff --git a/api/MathNet.Numerics.Optimization.LineSearch/WolfeLineSearch.htm b/api/MathNet.Numerics.Optimization.LineSearch/WolfeLineSearch.htm index 263d91a7..96f3d39b 100644 --- a/api/MathNet.Numerics.Optimization.LineSearch/WolfeLineSearch.htm +++ b/api/MathNet.Numerics.Optimization.LineSearch/WolfeLineSearch.htm @@ -261,7 +261,7 @@ diff --git a/api/MathNet.Numerics.Optimization.LineSearch/index.htm b/api/MathNet.Numerics.Optimization.LineSearch/index.htm index 1712faea..64359812 100644 --- a/api/MathNet.Numerics.Optimization.LineSearch/index.htm +++ b/api/MathNet.Numerics.Optimization.LineSearch/index.htm @@ -155,7 +155,7 @@ diff --git a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm index 582570cb..15cb04f5 100644 --- a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm +++ b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm @@ -323,7 +323,7 @@ functions's number of input parameters. diff --git a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/LazyObjectiveFunctionBase.htm b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/LazyObjectiveFunctionBase.htm index 1fd12e1e..6d2b8e71 100644 --- a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/LazyObjectiveFunctionBase.htm +++ b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/LazyObjectiveFunctionBase.htm @@ -279,7 +279,7 @@ diff --git a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ObjectiveFunctionBase.htm b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ObjectiveFunctionBase.htm index 4cbd3fa2..a2cd9563 100644 --- a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ObjectiveFunctionBase.htm +++ b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/ObjectiveFunctionBase.htm @@ -279,7 +279,7 @@ diff --git a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm index ccbf4613..ac610e97 100644 --- a/api/MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm +++ b/api/MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm @@ -151,7 +151,7 @@ diff --git a/api/MathNet.Numerics.Optimization.TrustRegion/ITrustRegionSubproblem.htm b/api/MathNet.Numerics.Optimization.TrustRegion/ITrustRegionSubproblem.htm index 23b0767a..b360f79e 100644 --- a/api/MathNet.Numerics.Optimization.TrustRegion/ITrustRegionSubproblem.htm +++ b/api/MathNet.Numerics.Optimization.TrustRegion/ITrustRegionSubproblem.htm @@ -196,7 +196,7 @@ diff --git a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionDogLegMinimizer.htm b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionDogLegMinimizer.htm index 3da9fdd1..b41199cf 100644 --- a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionDogLegMinimizer.htm +++ b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionDogLegMinimizer.htm @@ -243,7 +243,7 @@ diff --git a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionMinimizerBase.htm b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionMinimizerBase.htm index b1f929c9..ec0a68ab 100644 --- a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionMinimizerBase.htm +++ b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionMinimizerBase.htm @@ -312,7 +312,7 @@ diff --git a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionNewtonCGMinimizer.htm b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionNewtonCGMinimizer.htm index 174f6d99..d6939513 100644 --- a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionNewtonCGMinimizer.htm +++ b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionNewtonCGMinimizer.htm @@ -243,7 +243,7 @@ diff --git a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionSubproblem.htm b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionSubproblem.htm index 11b64125..bb86d759 100644 --- a/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionSubproblem.htm +++ b/api/MathNet.Numerics.Optimization.TrustRegion/TrustRegionSubproblem.htm @@ -187,7 +187,7 @@ diff --git a/api/MathNet.Numerics.Optimization.TrustRegion/index.htm b/api/MathNet.Numerics.Optimization.TrustRegion/index.htm index 909e8a48..e8ef29fc 100644 --- a/api/MathNet.Numerics.Optimization.TrustRegion/index.htm +++ b/api/MathNet.Numerics.Optimization.TrustRegion/index.htm @@ -162,7 +162,7 @@ diff --git a/api/MathNet.Numerics.Optimization/BfgsBMinimizer.htm b/api/MathNet.Numerics.Optimization/BfgsBMinimizer.htm index 7aec14a2..23951d3a 100644 --- a/api/MathNet.Numerics.Optimization/BfgsBMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/BfgsBMinimizer.htm @@ -367,7 +367,7 @@ http://www.ece.northwestern.edu/~nocedal/PSfiles/limited.ps.gz diff --git a/api/MathNet.Numerics.Optimization/BfgsMinimizer.htm b/api/MathNet.Numerics.Optimization/BfgsMinimizer.htm index 1ad38f4f..12927161 100644 --- a/api/MathNet.Numerics.Optimization/BfgsMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/BfgsMinimizer.htm @@ -375,7 +375,7 @@ diff --git a/api/MathNet.Numerics.Optimization/BfgsMinimizerBase.htm b/api/MathNet.Numerics.Optimization/BfgsMinimizerBase.htm index 9c7b89e1..a09b4c6d 100644 --- a/api/MathNet.Numerics.Optimization/BfgsMinimizerBase.htm +++ b/api/MathNet.Numerics.Optimization/BfgsMinimizerBase.htm @@ -322,7 +322,7 @@ diff --git a/api/MathNet.Numerics.Optimization/BfgsSolver.htm b/api/MathNet.Numerics.Optimization/BfgsSolver.htm index 29c2d032..575f8dfa 100644 --- a/api/MathNet.Numerics.Optimization/BfgsSolver.htm +++ b/api/MathNet.Numerics.Optimization/BfgsSolver.htm @@ -278,7 +278,7 @@ This uses the function and it's gradient (partial derivatives in each direction) diff --git a/api/MathNet.Numerics.Optimization/ConjugateGradientMinimizer.htm b/api/MathNet.Numerics.Optimization/ConjugateGradientMinimizer.htm index c89ab0fb..f392bbaa 100644 --- a/api/MathNet.Numerics.Optimization/ConjugateGradientMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/ConjugateGradientMinimizer.htm @@ -348,7 +348,7 @@ diff --git a/api/MathNet.Numerics.Optimization/EvaluationException.htm b/api/MathNet.Numerics.Optimization/EvaluationException.htm index f4c5a012..1bb365f6 100644 --- a/api/MathNet.Numerics.Optimization/EvaluationException.htm +++ b/api/MathNet.Numerics.Optimization/EvaluationException.htm @@ -402,7 +402,7 @@ diff --git a/api/MathNet.Numerics.Optimization/ExitCondition.htm b/api/MathNet.Numerics.Optimization/ExitCondition.htm index b5c101a6..190706b5 100644 --- a/api/MathNet.Numerics.Optimization/ExitCondition.htm +++ b/api/MathNet.Numerics.Optimization/ExitCondition.htm @@ -529,7 +529,7 @@ diff --git a/api/MathNet.Numerics.Optimization/GoldenSectionMinimizer.htm b/api/MathNet.Numerics.Optimization/GoldenSectionMinimizer.htm index 945b7e17..4287d5b8 100644 --- a/api/MathNet.Numerics.Optimization/GoldenSectionMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/GoldenSectionMinimizer.htm @@ -368,7 +368,7 @@ diff --git a/api/MathNet.Numerics.Optimization/GradientProjectionResult.htm b/api/MathNet.Numerics.Optimization/GradientProjectionResult.htm index 8c436883..7e9e0810 100644 --- a/api/MathNet.Numerics.Optimization/GradientProjectionResult.htm +++ b/api/MathNet.Numerics.Optimization/GradientProjectionResult.htm @@ -330,7 +330,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IObjectiveFunction.htm b/api/MathNet.Numerics.Optimization/IObjectiveFunction.htm index 21124d35..c92e4243 100644 --- a/api/MathNet.Numerics.Optimization/IObjectiveFunction.htm +++ b/api/MathNet.Numerics.Optimization/IObjectiveFunction.htm @@ -271,7 +271,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IObjectiveFunctionEvaluation.htm b/api/MathNet.Numerics.Optimization/IObjectiveFunctionEvaluation.htm index 57cb1807..675b8a31 100644 --- a/api/MathNet.Numerics.Optimization/IObjectiveFunctionEvaluation.htm +++ b/api/MathNet.Numerics.Optimization/IObjectiveFunctionEvaluation.htm @@ -307,7 +307,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IObjectiveModel.htm b/api/MathNet.Numerics.Optimization/IObjectiveModel.htm index 85a4cb0f..2223e136 100644 --- a/api/MathNet.Numerics.Optimization/IObjectiveModel.htm +++ b/api/MathNet.Numerics.Optimization/IObjectiveModel.htm @@ -289,7 +289,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IObjectiveModelEvaluation.htm b/api/MathNet.Numerics.Optimization/IObjectiveModelEvaluation.htm index c78a441a..f8ada45e 100644 --- a/api/MathNet.Numerics.Optimization/IObjectiveModelEvaluation.htm +++ b/api/MathNet.Numerics.Optimization/IObjectiveModelEvaluation.htm @@ -347,7 +347,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IScalarObjectiveFunction.htm b/api/MathNet.Numerics.Optimization/IScalarObjectiveFunction.htm index edfedeb5..4d5472a1 100644 --- a/api/MathNet.Numerics.Optimization/IScalarObjectiveFunction.htm +++ b/api/MathNet.Numerics.Optimization/IScalarObjectiveFunction.htm @@ -277,7 +277,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IScalarObjectiveFunctionEvaluation.htm b/api/MathNet.Numerics.Optimization/IScalarObjectiveFunctionEvaluation.htm index c59d27de..7e628111 100644 --- a/api/MathNet.Numerics.Optimization/IScalarObjectiveFunctionEvaluation.htm +++ b/api/MathNet.Numerics.Optimization/IScalarObjectiveFunctionEvaluation.htm @@ -276,7 +276,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IUnconstrainedMinimizer.htm b/api/MathNet.Numerics.Optimization/IUnconstrainedMinimizer.htm index 0f9ebfd7..206e5d4b 100644 --- a/api/MathNet.Numerics.Optimization/IUnconstrainedMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/IUnconstrainedMinimizer.htm @@ -258,7 +258,7 @@ diff --git a/api/MathNet.Numerics.Optimization/IncompatibleObjectiveException.htm b/api/MathNet.Numerics.Optimization/IncompatibleObjectiveException.htm index 6bbbddcb..426e6b4f 100644 --- a/api/MathNet.Numerics.Optimization/IncompatibleObjectiveException.htm +++ b/api/MathNet.Numerics.Optimization/IncompatibleObjectiveException.htm @@ -385,7 +385,7 @@ diff --git a/api/MathNet.Numerics.Optimization/InnerOptimizationException.htm b/api/MathNet.Numerics.Optimization/InnerOptimizationException.htm index 6280e908..4e5b3952 100644 --- a/api/MathNet.Numerics.Optimization/InnerOptimizationException.htm +++ b/api/MathNet.Numerics.Optimization/InnerOptimizationException.htm @@ -395,7 +395,7 @@ diff --git a/api/MathNet.Numerics.Optimization/LevenbergMarquardtMinimizer.htm b/api/MathNet.Numerics.Optimization/LevenbergMarquardtMinimizer.htm index 42cce66e..1d3af367 100644 --- a/api/MathNet.Numerics.Optimization/LevenbergMarquardtMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/LevenbergMarquardtMinimizer.htm @@ -378,7 +378,7 @@ diff --git a/api/MathNet.Numerics.Optimization/LimitedMemoryBfgsMinimizer.htm b/api/MathNet.Numerics.Optimization/LimitedMemoryBfgsMinimizer.htm index a7cff98a..2bc7d368 100644 --- a/api/MathNet.Numerics.Optimization/LimitedMemoryBfgsMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/LimitedMemoryBfgsMinimizer.htm @@ -380,7 +380,7 @@ diff --git a/api/MathNet.Numerics.Optimization/MaximumIterationsException.htm b/api/MathNet.Numerics.Optimization/MaximumIterationsException.htm index 90e5513f..21358e10 100644 --- a/api/MathNet.Numerics.Optimization/MaximumIterationsException.htm +++ b/api/MathNet.Numerics.Optimization/MaximumIterationsException.htm @@ -385,7 +385,7 @@ diff --git a/api/MathNet.Numerics.Optimization/MinimizationResult.htm b/api/MathNet.Numerics.Optimization/MinimizationResult.htm index d49a7223..f3238297 100644 --- a/api/MathNet.Numerics.Optimization/MinimizationResult.htm +++ b/api/MathNet.Numerics.Optimization/MinimizationResult.htm @@ -336,7 +336,7 @@ diff --git a/api/MathNet.Numerics.Optimization/MinimizationWithLineSearchResult.htm b/api/MathNet.Numerics.Optimization/MinimizationWithLineSearchResult.htm index 15e06d0a..840fde3e 100644 --- a/api/MathNet.Numerics.Optimization/MinimizationWithLineSearchResult.htm +++ b/api/MathNet.Numerics.Optimization/MinimizationWithLineSearchResult.htm @@ -351,7 +351,7 @@ diff --git a/api/MathNet.Numerics.Optimization/MinimizerBase.htm b/api/MathNet.Numerics.Optimization/MinimizerBase.htm index ec986596..30401d5f 100644 --- a/api/MathNet.Numerics.Optimization/MinimizerBase.htm +++ b/api/MathNet.Numerics.Optimization/MinimizerBase.htm @@ -321,7 +321,7 @@ diff --git a/api/MathNet.Numerics.Optimization/NelderMeadSimplex.htm b/api/MathNet.Numerics.Optimization/NelderMeadSimplex.htm index bad60efb..35399ab1 100644 --- a/api/MathNet.Numerics.Optimization/NelderMeadSimplex.htm +++ b/api/MathNet.Numerics.Optimization/NelderMeadSimplex.htm @@ -438,7 +438,7 @@ http://se.mathworks.com/help/matlab/math/optimizing-nonlinear-functions.html#bsg diff --git a/api/MathNet.Numerics.Optimization/NewtonMinimizer.htm b/api/MathNet.Numerics.Optimization/NewtonMinimizer.htm index 9c417c23..c1d44998 100644 --- a/api/MathNet.Numerics.Optimization/NewtonMinimizer.htm +++ b/api/MathNet.Numerics.Optimization/NewtonMinimizer.htm @@ -355,7 +355,7 @@ diff --git a/api/MathNet.Numerics.Optimization/NonlinearMinimizationResult.htm b/api/MathNet.Numerics.Optimization/NonlinearMinimizationResult.htm index bbcd9517..bd676b08 100644 --- a/api/MathNet.Numerics.Optimization/NonlinearMinimizationResult.htm +++ b/api/MathNet.Numerics.Optimization/NonlinearMinimizationResult.htm @@ -364,7 +364,7 @@ diff --git a/api/MathNet.Numerics.Optimization/NonlinearMinimizerBase.htm b/api/MathNet.Numerics.Optimization/NonlinearMinimizerBase.htm index 8a474da2..69fcbb31 100644 --- a/api/MathNet.Numerics.Optimization/NonlinearMinimizerBase.htm +++ b/api/MathNet.Numerics.Optimization/NonlinearMinimizerBase.htm @@ -342,7 +342,7 @@ diff --git a/api/MathNet.Numerics.Optimization/ObjectiveFunction.htm b/api/MathNet.Numerics.Optimization/ObjectiveFunction.htm index 213f9cfd..0be321f3 100644 --- a/api/MathNet.Numerics.Optimization/ObjectiveFunction.htm +++ b/api/MathNet.Numerics.Optimization/ObjectiveFunction.htm @@ -389,7 +389,7 @@ The numerical jacobian with accuracy order is used. diff --git a/api/MathNet.Numerics.Optimization/OptimizationException.htm b/api/MathNet.Numerics.Optimization/OptimizationException.htm index eb317d85..30469b65 100644 --- a/api/MathNet.Numerics.Optimization/OptimizationException.htm +++ b/api/MathNet.Numerics.Optimization/OptimizationException.htm @@ -395,7 +395,7 @@ diff --git a/api/MathNet.Numerics.Optimization/QuadraticGradientProjectionSearch.htm b/api/MathNet.Numerics.Optimization/QuadraticGradientProjectionSearch.htm index 85f48235..837d8c5a 100644 --- a/api/MathNet.Numerics.Optimization/QuadraticGradientProjectionSearch.htm +++ b/api/MathNet.Numerics.Optimization/QuadraticGradientProjectionSearch.htm @@ -258,7 +258,7 @@ diff --git a/api/MathNet.Numerics.Optimization/ScalarMinimizationResult.htm b/api/MathNet.Numerics.Optimization/ScalarMinimizationResult.htm index 5abe2704..bb6d072a 100644 --- a/api/MathNet.Numerics.Optimization/ScalarMinimizationResult.htm +++ b/api/MathNet.Numerics.Optimization/ScalarMinimizationResult.htm @@ -336,7 +336,7 @@ diff --git a/api/MathNet.Numerics.Optimization/index.htm b/api/MathNet.Numerics.Optimization/index.htm index c13b6290..160bb26a 100644 --- a/api/MathNet.Numerics.Optimization/index.htm +++ b/api/MathNet.Numerics.Optimization/index.htm @@ -270,7 +270,7 @@ diff --git a/api/MathNet.Numerics.Providers.Common.Cuda/CudaProvider.htm b/api/MathNet.Numerics.Providers.Common.Cuda/CudaProvider.htm index e0832fe9..a23f8a82 100644 --- a/api/MathNet.Numerics.Providers.Common.Cuda/CudaProvider.htm +++ b/api/MathNet.Numerics.Providers.Common.Cuda/CudaProvider.htm @@ -202,7 +202,7 @@ This method is safe to call, even if the provider is not loaded. diff --git a/api/MathNet.Numerics.Providers.Common.Cuda/index.htm b/api/MathNet.Numerics.Providers.Common.Cuda/index.htm index e48d4ea2..e5575ec3 100644 --- a/api/MathNet.Numerics.Providers.Common.Cuda/index.htm +++ b/api/MathNet.Numerics.Providers.Common.Cuda/index.htm @@ -143,7 +143,7 @@ diff --git a/api/MathNet.Numerics.Providers.Common.Mkl/MklAccuracy.htm b/api/MathNet.Numerics.Providers.Common.Mkl/MklAccuracy.htm index ac420c30..6694a89b 100644 --- a/api/MathNet.Numerics.Providers.Common.Mkl/MklAccuracy.htm +++ b/api/MathNet.Numerics.Providers.Common.Mkl/MklAccuracy.htm @@ -315,7 +315,7 @@ diff --git a/api/MathNet.Numerics.Providers.Common.Mkl/MklConsistency.htm b/api/MathNet.Numerics.Providers.Common.Mkl/MklConsistency.htm index 811754d7..f550f2e7 100644 --- a/api/MathNet.Numerics.Providers.Common.Mkl/MklConsistency.htm +++ b/api/MathNet.Numerics.Providers.Common.Mkl/MklConsistency.htm @@ -369,7 +369,7 @@ diff --git a/api/MathNet.Numerics.Providers.Common.Mkl/MklPrecision.htm b/api/MathNet.Numerics.Providers.Common.Mkl/MklPrecision.htm index ec86fece..38f42a8e 100644 --- a/api/MathNet.Numerics.Providers.Common.Mkl/MklPrecision.htm +++ b/api/MathNet.Numerics.Providers.Common.Mkl/MklPrecision.htm @@ -315,7 +315,7 @@ diff --git a/api/MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm b/api/MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm index 189fb0d3..4160a864 100644 --- a/api/MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm +++ b/api/MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm @@ -307,7 +307,7 @@ This method is safe to call, even if the provider is not loaded. diff --git a/api/MathNet.Numerics.Providers.Common.Mkl/index.htm b/api/MathNet.Numerics.Providers.Common.Mkl/index.htm index ed2f1a12..b86c9808 100644 --- a/api/MathNet.Numerics.Providers.Common.Mkl/index.htm +++ b/api/MathNet.Numerics.Providers.Common.Mkl/index.htm @@ -155,7 +155,7 @@ diff --git a/api/MathNet.Numerics.Providers.Common.OpenBlas/OpenBlasProvider.htm b/api/MathNet.Numerics.Providers.Common.OpenBlas/OpenBlasProvider.htm index 5a3ab05a..32a9e866 100644 --- a/api/MathNet.Numerics.Providers.Common.OpenBlas/OpenBlasProvider.htm +++ b/api/MathNet.Numerics.Providers.Common.OpenBlas/OpenBlasProvider.htm @@ -202,7 +202,7 @@ This method is safe to call, even if the provider is not loaded. diff --git a/api/MathNet.Numerics.Providers.Common.OpenBlas/index.htm b/api/MathNet.Numerics.Providers.Common.OpenBlas/index.htm index 63d2e3fc..1cdd177b 100644 --- a/api/MathNet.Numerics.Providers.Common.OpenBlas/index.htm +++ b/api/MathNet.Numerics.Providers.Common.OpenBlas/index.htm @@ -143,7 +143,7 @@ diff --git a/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformControl.htm b/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformControl.htm index ebaf6b73..109e1161 100644 --- a/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformControl.htm +++ b/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformControl.htm @@ -276,7 +276,7 @@ If not set, Numerics will fall back to the environment variable diff --git a/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformScaling.htm b/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformScaling.htm index 87689fdb..5b583301 100644 --- a/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformScaling.htm +++ b/api/MathNet.Numerics.Providers.FourierTransform/FourierTransformScaling.htm @@ -338,7 +338,7 @@ diff --git a/api/MathNet.Numerics.Providers.FourierTransform/IFourierTransformProvider.htm b/api/MathNet.Numerics.Providers.FourierTransform/IFourierTransformProvider.htm index d59ff3c7..71b081a1 100644 --- a/api/MathNet.Numerics.Providers.FourierTransform/IFourierTransformProvider.htm +++ b/api/MathNet.Numerics.Providers.FourierTransform/IFourierTransformProvider.htm @@ -313,7 +313,7 @@ Verification may still fail if available, but it will certainly fail if unavaila diff --git a/api/MathNet.Numerics.Providers.FourierTransform/index.htm b/api/MathNet.Numerics.Providers.FourierTransform/index.htm index 245176ce..8488293c 100644 --- a/api/MathNet.Numerics.Providers.FourierTransform/index.htm +++ b/api/MathNet.Numerics.Providers.FourierTransform/index.htm @@ -154,7 +154,7 @@ diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/NativeError.htm b/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/NativeError.htm index 80f66440..d8ebac92 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/NativeError.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/NativeError.htm @@ -295,7 +295,7 @@ diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/index.htm b/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/index.htm index 92617dc9..9289cd13 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/index.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra.OpenBlas/index.htm @@ -143,7 +143,7 @@ diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider.htm b/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider.htm index 1212035f..1704f00b 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider.htm @@ -202,7 +202,7 @@ Verification may still fail if available, but it will certainly fail if unavaila diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider`1.htm b/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider`1.htm index 573236b7..61297b90 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider`1.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra/ILinearAlgebraProvider`1.htm @@ -899,7 +899,7 @@ to be used by the QR solve routine.

    diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra/LinearAlgebraControl.htm b/api/MathNet.Numerics.Providers.LinearAlgebra/LinearAlgebraControl.htm index adee74d5..c5305b4a 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra/LinearAlgebraControl.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra/LinearAlgebraControl.htm @@ -343,7 +343,7 @@ Consider to use UseNativeMKL or UseManaged instead. diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra/Norm.htm b/api/MathNet.Numerics.Providers.LinearAlgebra/Norm.htm index 2a5fcf1b..d0e15fcc 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra/Norm.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra/Norm.htm @@ -346,7 +346,7 @@ diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra/Transpose.htm b/api/MathNet.Numerics.Providers.LinearAlgebra/Transpose.htm index 1d67a394..94c548f4 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra/Transpose.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra/Transpose.htm @@ -335,7 +335,7 @@ diff --git a/api/MathNet.Numerics.Providers.LinearAlgebra/index.htm b/api/MathNet.Numerics.Providers.LinearAlgebra/index.htm index a3aab1d7..2cbd0ccf 100644 --- a/api/MathNet.Numerics.Providers.LinearAlgebra/index.htm +++ b/api/MathNet.Numerics.Providers.LinearAlgebra/index.htm @@ -162,7 +162,7 @@ diff --git a/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixStructure.htm b/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixStructure.htm index 4dfd9cf1..573f8276 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixStructure.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixStructure.htm @@ -378,7 +378,7 @@ diff --git a/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixType.htm b/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixType.htm index 21fcba7e..ef421c28 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixType.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/DssMatrixType.htm @@ -352,7 +352,7 @@ diff --git a/api/MathNet.Numerics.Providers.SparseSolver/DssStatus.htm b/api/MathNet.Numerics.Providers.SparseSolver/DssStatus.htm index 3b168fb6..e730c5ec 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/DssStatus.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/DssStatus.htm @@ -651,7 +651,7 @@ diff --git a/api/MathNet.Numerics.Providers.SparseSolver/DssSystemType.htm b/api/MathNet.Numerics.Providers.SparseSolver/DssSystemType.htm index 02a6330b..63e80c93 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/DssSystemType.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/DssSystemType.htm @@ -339,7 +339,7 @@ diff --git a/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider.htm b/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider.htm index c14ddea3..58df3ae6 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider.htm @@ -206,7 +206,7 @@ Verification may still fail if available, but it will certainly fail if unavaila diff --git a/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider`1.htm b/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider`1.htm index f0596cb9..a8bb280b 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider`1.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/ISparseSolverProvider`1.htm @@ -183,7 +183,7 @@ diff --git a/api/MathNet.Numerics.Providers.SparseSolver/SparseSolverControl.htm b/api/MathNet.Numerics.Providers.SparseSolver/SparseSolverControl.htm index 9fb56321..cfac1b36 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/SparseSolverControl.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/SparseSolverControl.htm @@ -288,7 +288,7 @@ If not set, Numerics will fall back to the environment variable diff --git a/api/MathNet.Numerics.Providers.SparseSolver/index.htm b/api/MathNet.Numerics.Providers.SparseSolver/index.htm index 53a223d9..bd925d66 100644 --- a/api/MathNet.Numerics.Providers.SparseSolver/index.htm +++ b/api/MathNet.Numerics.Providers.SparseSolver/index.htm @@ -170,7 +170,7 @@ diff --git a/api/MathNet.Numerics.Random/CryptoRandomSource.htm b/api/MathNet.Numerics.Random/CryptoRandomSource.htm index 14d829a0..90f9608c 100644 --- a/api/MathNet.Numerics.Random/CryptoRandomSource.htm +++ b/api/MathNet.Numerics.Random/CryptoRandomSource.htm @@ -618,7 +618,7 @@ diff --git a/api/MathNet.Numerics.Random/Mcg31m1.htm b/api/MathNet.Numerics.Random/Mcg31m1.htm index af746d99..1a19fedd 100644 --- a/api/MathNet.Numerics.Random/Mcg31m1.htm +++ b/api/MathNet.Numerics.Random/Mcg31m1.htm @@ -607,7 +607,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/Mcg59.htm b/api/MathNet.Numerics.Random/Mcg59.htm index d256e9c5..172e16ec 100644 --- a/api/MathNet.Numerics.Random/Mcg59.htm +++ b/api/MathNet.Numerics.Random/Mcg59.htm @@ -609,7 +609,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/MersenneTwister.htm b/api/MathNet.Numerics.Random/MersenneTwister.htm index 04c44304..29fdd6cb 100644 --- a/api/MathNet.Numerics.Random/MersenneTwister.htm +++ b/api/MathNet.Numerics.Random/MersenneTwister.htm @@ -622,7 +622,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/Mrg32k3a.htm b/api/MathNet.Numerics.Random/Mrg32k3a.htm index 737b53c7..822fa1f9 100644 --- a/api/MathNet.Numerics.Random/Mrg32k3a.htm +++ b/api/MathNet.Numerics.Random/Mrg32k3a.htm @@ -613,7 +613,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/Palf.htm b/api/MathNet.Numerics.Random/Palf.htm index 55097a59..177bfdde 100644 --- a/api/MathNet.Numerics.Random/Palf.htm +++ b/api/MathNet.Numerics.Random/Palf.htm @@ -655,7 +655,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/RandomExtensions.htm b/api/MathNet.Numerics.Random/RandomExtensions.htm index 7abfd300..a5c65a20 100644 --- a/api/MathNet.Numerics.Random/RandomExtensions.htm +++ b/api/MathNet.Numerics.Random/RandomExtensions.htm @@ -449,7 +449,7 @@ the range of return values includes 0 but not -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics.Random/RandomSeed.htm b/api/MathNet.Numerics.Random/RandomSeed.htm index 292286b4..f4568f2c 100644 --- a/api/MathNet.Numerics.Random/RandomSeed.htm +++ b/api/MathNet.Numerics.Random/RandomSeed.htm @@ -230,7 +230,7 @@ the same seed value. Do not use for cryptography! diff --git a/api/MathNet.Numerics.Random/RandomSource.htm b/api/MathNet.Numerics.Random/RandomSource.htm index 7101625b..a5b9acda 100644 --- a/api/MathNet.Numerics.Random/RandomSource.htm +++ b/api/MathNet.Numerics.Random/RandomSource.htm @@ -496,7 +496,7 @@ When used directly it use the System.Random as random number source. diff --git a/api/MathNet.Numerics.Random/SystemRandomSource.htm b/api/MathNet.Numerics.Random/SystemRandomSource.htm index 085e7e57..22030545 100644 --- a/api/MathNet.Numerics.Random/SystemRandomSource.htm +++ b/api/MathNet.Numerics.Random/SystemRandomSource.htm @@ -651,7 +651,7 @@ WARNING: potentially very short random sequence length, can generate repeated pa diff --git a/api/MathNet.Numerics.Random/WH1982.htm b/api/MathNet.Numerics.Random/WH1982.htm index 305621da..f7973a21 100644 --- a/api/MathNet.Numerics.Random/WH1982.htm +++ b/api/MathNet.Numerics.Random/WH1982.htm @@ -612,7 +612,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/WH2006.htm b/api/MathNet.Numerics.Random/WH2006.htm index 06764020..ddf59de2 100644 --- a/api/MathNet.Numerics.Random/WH2006.htm +++ b/api/MathNet.Numerics.Random/WH2006.htm @@ -612,7 +612,7 @@ set whether the instance is thread safe. diff --git a/api/MathNet.Numerics.Random/Xorshift.htm b/api/MathNet.Numerics.Random/Xorshift.htm index c76ff69d..e0625358 100644 --- a/api/MathNet.Numerics.Random/Xorshift.htm +++ b/api/MathNet.Numerics.Random/Xorshift.htm @@ -728,7 +728,7 @@ Uses the default values of:
    diff --git a/api/MathNet.Numerics.Random/Xoshiro256StarStar.htm b/api/MathNet.Numerics.Random/Xoshiro256StarStar.htm index dae7c768..cee56056 100644 --- a/api/MathNet.Numerics.Random/Xoshiro256StarStar.htm +++ b/api/MathNet.Numerics.Random/Xoshiro256StarStar.htm @@ -613,7 +613,7 @@ https://arxiv.org/abs/1805.01407 diff --git a/api/MathNet.Numerics.Random/index.htm b/api/MathNet.Numerics.Random/index.htm index d1b25152..9789c0da 100644 --- a/api/MathNet.Numerics.Random/index.htm +++ b/api/MathNet.Numerics.Random/index.htm @@ -195,7 +195,7 @@ diff --git a/api/MathNet.Numerics.RootFinding/Bisection.htm b/api/MathNet.Numerics.RootFinding/Bisection.htm index c1a8fd10..cb3fa41b 100644 --- a/api/MathNet.Numerics.RootFinding/Bisection.htm +++ b/api/MathNet.Numerics.RootFinding/Bisection.htm @@ -250,7 +250,7 @@ diff --git a/api/MathNet.Numerics.RootFinding/Brent.htm b/api/MathNet.Numerics.RootFinding/Brent.htm index a1816f77..1ade2e5e 100644 --- a/api/MathNet.Numerics.RootFinding/Brent.htm +++ b/api/MathNet.Numerics.RootFinding/Brent.htm @@ -251,7 +251,7 @@ Implementation inspired by Press, Teukolsky, Vetterling, and Flannery, "Numerica diff --git a/api/MathNet.Numerics.RootFinding/Broyden.htm b/api/MathNet.Numerics.RootFinding/Broyden.htm index 725fdd6e..04c418d1 100644 --- a/api/MathNet.Numerics.RootFinding/Broyden.htm +++ b/api/MathNet.Numerics.RootFinding/Broyden.htm @@ -228,7 +228,7 @@ Implementation inspired by Press, Teukolsky, Vetterling, and Flannery, "Numerica diff --git a/api/MathNet.Numerics.RootFinding/Cubic.htm b/api/MathNet.Numerics.RootFinding/Cubic.htm index d79a5342..77f34db0 100644 --- a/api/MathNet.Numerics.RootFinding/Cubic.htm +++ b/api/MathNet.Numerics.RootFinding/Cubic.htm @@ -201,7 +201,7 @@ Note the special coefficient order ascending by exponent (consistent with polyno diff --git a/api/MathNet.Numerics.RootFinding/NewtonRaphson.htm b/api/MathNet.Numerics.RootFinding/NewtonRaphson.htm index 5e7a2796..24c32657 100644 --- a/api/MathNet.Numerics.RootFinding/NewtonRaphson.htm +++ b/api/MathNet.Numerics.RootFinding/NewtonRaphson.htm @@ -253,7 +253,7 @@ The algorithm aborts immediately if the root leaves the bound interval. diff --git a/api/MathNet.Numerics.RootFinding/RobustNewtonRaphson.htm b/api/MathNet.Numerics.RootFinding/RobustNewtonRaphson.htm index d82dd624..98f88970 100644 --- a/api/MathNet.Numerics.RootFinding/RobustNewtonRaphson.htm +++ b/api/MathNet.Numerics.RootFinding/RobustNewtonRaphson.htm @@ -221,7 +221,7 @@ diff --git a/api/MathNet.Numerics.RootFinding/Secant.htm b/api/MathNet.Numerics.RootFinding/Secant.htm index 77f4c175..a88d5b10 100644 --- a/api/MathNet.Numerics.RootFinding/Secant.htm +++ b/api/MathNet.Numerics.RootFinding/Secant.htm @@ -222,7 +222,7 @@ The algorithm aborts immediately if the root leaves the bound interval. diff --git a/api/MathNet.Numerics.RootFinding/ZeroCrossingBracketing.htm b/api/MathNet.Numerics.RootFinding/ZeroCrossingBracketing.htm index 68312f7c..2881a4f4 100644 --- a/api/MathNet.Numerics.RootFinding/ZeroCrossingBracketing.htm +++ b/api/MathNet.Numerics.RootFinding/ZeroCrossingBracketing.htm @@ -216,7 +216,7 @@ diff --git a/api/MathNet.Numerics.RootFinding/index.htm b/api/MathNet.Numerics.RootFinding/index.htm index 90ed3579..14abaf16 100644 --- a/api/MathNet.Numerics.RootFinding/index.htm +++ b/api/MathNet.Numerics.RootFinding/index.htm @@ -171,7 +171,7 @@ diff --git a/api/MathNet.Numerics.Statistics.Mcmc/DensityLn`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/DensityLn`1.htm index 008d413f..b92dcc8d 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/DensityLn`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/DensityLn`1.htm @@ -344,7 +344,7 @@ diff --git a/api/MathNet.Numerics.Statistics.Mcmc/Density`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/Density`1.htm index f7902c90..2d873cae 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/Density`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/Density`1.htm @@ -344,7 +344,7 @@ diff --git a/api/MathNet.Numerics.Statistics.Mcmc/DiffMethod.htm b/api/MathNet.Numerics.Statistics.Mcmc/DiffMethod.htm index cffb05b3..2345244b 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/DiffMethod.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/DiffMethod.htm @@ -342,7 +342,7 @@ diff --git a/api/MathNet.Numerics.Statistics.Mcmc/GlobalProposalSampler`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/GlobalProposalSampler`1.htm index f0af04c1..f088b1cc 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/GlobalProposalSampler`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/GlobalProposalSampler`1.htm @@ -346,7 +346,7 @@ variables from the whole domain. diff --git a/api/MathNet.Numerics.Statistics.Mcmc/HybridMC.htm b/api/MathNet.Numerics.Statistics.Mcmc/HybridMC.htm index 28f24741..6e064188 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/HybridMC.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/HybridMC.htm @@ -426,7 +426,7 @@ momentum. diff --git a/api/MathNet.Numerics.Statistics.Mcmc/HybridMCGeneric`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/HybridMCGeneric`1.htm index 530c927f..54d5550b 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/HybridMCGeneric`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/HybridMCGeneric`1.htm @@ -315,7 +315,7 @@ to sample the distribution. This can result in a faster convergence than the ran diff --git a/api/MathNet.Numerics.Statistics.Mcmc/LocalProposalSampler`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/LocalProposalSampler`1.htm index 8ffc06c7..dd795a66 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/LocalProposalSampler`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/LocalProposalSampler`1.htm @@ -346,7 +346,7 @@ makes a small local move rather than producing a global sample from the proposal diff --git a/api/MathNet.Numerics.Statistics.Mcmc/MCMCDiagnostics.htm b/api/MathNet.Numerics.Statistics.Mcmc/MCMCDiagnostics.htm index fd563abc..f82feff9 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/MCMCDiagnostics.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/MCMCDiagnostics.htm @@ -248,7 +248,7 @@ a . diff --git a/api/MathNet.Numerics.Statistics.Mcmc/McmcSampler`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/McmcSampler`1.htm index 97f3af2d..def5cb3a 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/McmcSampler`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/McmcSampler`1.htm @@ -289,7 +289,7 @@ diff --git a/api/MathNet.Numerics.Statistics.Mcmc/MetropolisHastingsSampler`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/MetropolisHastingsSampler`1.htm index d9422cdf..da129f2b 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/MetropolisHastingsSampler`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/MetropolisHastingsSampler`1.htm @@ -332,7 +332,7 @@ constructor will set the burn interval. diff --git a/api/MathNet.Numerics.Statistics.Mcmc/MetropolisSampler`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/MetropolisSampler`1.htm index 45180c3e..3e63d4f4 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/MetropolisSampler`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/MetropolisSampler`1.htm @@ -328,7 +328,7 @@ of the distribution P. diff --git a/api/MathNet.Numerics.Statistics.Mcmc/RejectionSampler`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/RejectionSampler`1.htm index 0d7cec72..6a790a9d 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/RejectionSampler`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/RejectionSampler`1.htm @@ -317,7 +317,7 @@ to be normalized, but we do need that for each x, P(x) < Q(x). diff --git a/api/MathNet.Numerics.Statistics.Mcmc/TransitionKernelLn`1.htm b/api/MathNet.Numerics.Statistics.Mcmc/TransitionKernelLn`1.htm index 4ca268cd..8d00a9b5 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/TransitionKernelLn`1.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/TransitionKernelLn`1.htm @@ -344,7 +344,7 @@ diff --git a/api/MathNet.Numerics.Statistics.Mcmc/UnivariateHybridMC.htm b/api/MathNet.Numerics.Statistics.Mcmc/UnivariateHybridMC.htm index 68d1a3cd..d9c5a593 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/UnivariateHybridMC.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/UnivariateHybridMC.htm @@ -398,7 +398,7 @@ momentum. diff --git a/api/MathNet.Numerics.Statistics.Mcmc/UnivariateSliceSampler.htm b/api/MathNet.Numerics.Statistics.Mcmc/UnivariateSliceSampler.htm index 8fc3258c..307af39a 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/UnivariateSliceSampler.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/UnivariateSliceSampler.htm @@ -356,7 +356,7 @@ will set the number of burnInterval iterations and run a burnInterval phase. diff --git a/api/MathNet.Numerics.Statistics.Mcmc/index.htm b/api/MathNet.Numerics.Statistics.Mcmc/index.htm index f78fa8bd..f733bfcb 100644 --- a/api/MathNet.Numerics.Statistics.Mcmc/index.htm +++ b/api/MathNet.Numerics.Statistics.Mcmc/index.htm @@ -199,7 +199,7 @@ diff --git a/api/MathNet.Numerics.Statistics/ArrayStatistics.htm b/api/MathNet.Numerics.Statistics/ArrayStatistics.htm index c5682890..b60c32da 100644 --- a/api/MathNet.Numerics.Statistics/ArrayStatistics.htm +++ b/api/MathNet.Numerics.Statistics/ArrayStatistics.htm @@ -1490,7 +1490,7 @@ Returns NaN if data has less than two entries or if any entry is NaN. diff --git a/api/MathNet.Numerics.Statistics/Bucket.htm b/api/MathNet.Numerics.Statistics/Bucket.htm index 82dd624e..ad036e44 100644 --- a/api/MathNet.Numerics.Statistics/Bucket.htm +++ b/api/MathNet.Numerics.Statistics/Bucket.htm @@ -371,7 +371,7 @@ difference in Count given by . diff --git a/api/MathNet.Numerics.Statistics/Correlation.htm b/api/MathNet.Numerics.Statistics/Correlation.htm index 1e575e3d..9cd2b012 100644 --- a/api/MathNet.Numerics.Statistics/Correlation.htm +++ b/api/MathNet.Numerics.Statistics/Correlation.htm @@ -395,7 +395,7 @@ diff --git a/api/MathNet.Numerics.Statistics/DescriptiveStatistics.htm b/api/MathNet.Numerics.Statistics/DescriptiveStatistics.htm index 3287db7c..18fd73f9 100644 --- a/api/MathNet.Numerics.Statistics/DescriptiveStatistics.htm +++ b/api/MathNet.Numerics.Statistics/DescriptiveStatistics.htm @@ -350,7 +350,7 @@ Increased accuracy mode uses Decimal types diff --git a/api/MathNet.Numerics.Statistics/Histogram.htm b/api/MathNet.Numerics.Statistics/Histogram.htm index dee41ae3..e6c26543 100644 --- a/api/MathNet.Numerics.Statistics/Histogram.htm +++ b/api/MathNet.Numerics.Statistics/Histogram.htm @@ -415,7 +415,7 @@ the lowerbound or upperbound will automatically adapt. diff --git a/api/MathNet.Numerics.Statistics/KernelDensity.htm b/api/MathNet.Numerics.Statistics/KernelDensity.htm index 9e14d13d..9fef5cb0 100644 --- a/api/MathNet.Numerics.Statistics/KernelDensity.htm +++ b/api/MathNet.Numerics.Statistics/KernelDensity.htm @@ -290,7 +290,7 @@ x => Math.Abs(x) <= 1.0 ? 1.0/2.0 : 0.0 diff --git a/api/MathNet.Numerics.Statistics/MovingStatistics.htm b/api/MathNet.Numerics.Statistics/MovingStatistics.htm index af058eb4..bcc5eace 100644 --- a/api/MathNet.Numerics.Statistics/MovingStatistics.htm +++ b/api/MathNet.Numerics.Statistics/MovingStatistics.htm @@ -357,7 +357,7 @@ Returns NaN if data has less than two entries or if any entry is NaN. diff --git a/api/MathNet.Numerics.Statistics/QuantileDefinition.htm b/api/MathNet.Numerics.Statistics/QuantileDefinition.htm index 80ff8478..696a0641 100644 --- a/api/MathNet.Numerics.Statistics/QuantileDefinition.htm +++ b/api/MathNet.Numerics.Statistics/QuantileDefinition.htm @@ -693,7 +693,7 @@ diff --git a/api/MathNet.Numerics.Statistics/RankDefinition.htm b/api/MathNet.Numerics.Statistics/RankDefinition.htm index 641e1d33..3cc68832 100644 --- a/api/MathNet.Numerics.Statistics/RankDefinition.htm +++ b/api/MathNet.Numerics.Statistics/RankDefinition.htm @@ -407,7 +407,7 @@ diff --git a/api/MathNet.Numerics.Statistics/RunningStatistics.htm b/api/MathNet.Numerics.Statistics/RunningStatistics.htm index 99f6ee51..6aeab4a4 100644 --- a/api/MathNet.Numerics.Statistics/RunningStatistics.htm +++ b/api/MathNet.Numerics.Statistics/RunningStatistics.htm @@ -407,7 +407,7 @@ Returns NaN if data has less than two entries or if any entry is NaN. diff --git a/api/MathNet.Numerics.Statistics/SortedArrayStatistics.htm b/api/MathNet.Numerics.Statistics/SortedArrayStatistics.htm index 80989aca..2b29d05d 100644 --- a/api/MathNet.Numerics.Statistics/SortedArrayStatistics.htm +++ b/api/MathNet.Numerics.Statistics/SortedArrayStatistics.htm @@ -763,7 +763,7 @@ Approximately median-unbiased regardless of the sample distribution (R8). diff --git a/api/MathNet.Numerics.Statistics/Statistics.htm b/api/MathNet.Numerics.Statistics/Statistics.htm index 6b7177f7..27050398 100644 --- a/api/MathNet.Numerics.Statistics/Statistics.htm +++ b/api/MathNet.Numerics.Statistics/Statistics.htm @@ -1121,7 +1121,7 @@ Returns NaN if data has less than two entries or if any entry is NaN. diff --git a/api/MathNet.Numerics.Statistics/StreamingStatistics.htm b/api/MathNet.Numerics.Statistics/StreamingStatistics.htm index b0a6bc30..eaae6dba 100644 --- a/api/MathNet.Numerics.Statistics/StreamingStatistics.htm +++ b/api/MathNet.Numerics.Statistics/StreamingStatistics.htm @@ -529,7 +529,7 @@ Returns NaN if data has less than two entries or if any entry is NaN. diff --git a/api/MathNet.Numerics.Statistics/index.htm b/api/MathNet.Numerics.Statistics/index.htm index 52f71b4a..b852f4fb 100644 --- a/api/MathNet.Numerics.Statistics/index.htm +++ b/api/MathNet.Numerics.Statistics/index.htm @@ -191,7 +191,7 @@ diff --git a/api/MathNet.Numerics/AppSwitches.htm b/api/MathNet.Numerics/AppSwitches.htm index 7947c796..05b299e0 100644 --- a/api/MathNet.Numerics/AppSwitches.htm +++ b/api/MathNet.Numerics/AppSwitches.htm @@ -306,7 +306,7 @@ which cannot be controlled though configuration or through AppContext. diff --git a/api/MathNet.Numerics/Combinatorics.htm b/api/MathNet.Numerics/Combinatorics.htm index 4226a3b9..d7bc24ac 100644 --- a/api/MathNet.Numerics/Combinatorics.htm +++ b/api/MathNet.Numerics/Combinatorics.htm @@ -663,7 +663,7 @@ The order matters and each object can be chosen more than once. diff --git a/api/MathNet.Numerics/Complex32.htm b/api/MathNet.Numerics/Complex32.htm index cef98d97..353a2e9f 100644 --- a/api/MathNet.Numerics/Complex32.htm +++ b/api/MathNet.Numerics/Complex32.htm @@ -1472,7 +1472,7 @@ with real and imaginary numbers not a number. diff --git a/api/MathNet.Numerics/ComplexExtensions.htm b/api/MathNet.Numerics/ComplexExtensions.htm index 790ddc77..aa56735f 100644 --- a/api/MathNet.Numerics/ComplexExtensions.htm +++ b/api/MathNet.Numerics/ComplexExtensions.htm @@ -865,7 +865,7 @@ formatting information.

    diff --git a/api/MathNet.Numerics/Constants.htm b/api/MathNet.Numerics/Constants.htm index e5b88619..7f2922de 100644 --- a/api/MathNet.Numerics/Constants.htm +++ b/api/MathNet.Numerics/Constants.htm @@ -1983,7 +1983,7 @@ diff --git a/api/MathNet.Numerics/ContourIntegrate.htm b/api/MathNet.Numerics/ContourIntegrate.htm index f249a4fc..8acb2e9d 100644 --- a/api/MathNet.Numerics/ContourIntegrate.htm +++ b/api/MathNet.Numerics/ContourIntegrate.htm @@ -354,7 +354,7 @@ diff --git a/api/MathNet.Numerics/Control.htm b/api/MathNet.Numerics/Control.htm index c6ccfd43..370914b0 100644 --- a/api/MathNet.Numerics/Control.htm +++ b/api/MathNet.Numerics/Control.htm @@ -506,7 +506,7 @@ Thread safe RNG about two and half time slower than non-thread safe RNG. diff --git a/api/MathNet.Numerics/DifferIntegrate.htm b/api/MathNet.Numerics/DifferIntegrate.htm index 6bf41b15..e67eaf50 100644 --- a/api/MathNet.Numerics/DifferIntegrate.htm +++ b/api/MathNet.Numerics/DifferIntegrate.htm @@ -352,7 +352,7 @@ diff --git a/api/MathNet.Numerics/Differentiate.htm b/api/MathNet.Numerics/Differentiate.htm index f03afdf0..e4b2eb0c 100644 --- a/api/MathNet.Numerics/Differentiate.htm +++ b/api/MathNet.Numerics/Differentiate.htm @@ -549,7 +549,7 @@ diff --git a/api/MathNet.Numerics/Distance.htm b/api/MathNet.Numerics/Distance.htm index e8277c38..ca307a9f 100644 --- a/api/MathNet.Numerics/Distance.htm +++ b/api/MathNet.Numerics/Distance.htm @@ -599,7 +599,7 @@ diff --git a/api/MathNet.Numerics/Euclid.htm b/api/MathNet.Numerics/Euclid.htm index 09d5ddf2..5cadc2c5 100644 --- a/api/MathNet.Numerics/Euclid.htm +++ b/api/MathNet.Numerics/Euclid.htm @@ -864,7 +864,7 @@ algorithm. diff --git a/api/MathNet.Numerics/Evaluate.htm b/api/MathNet.Numerics/Evaluate.htm index ec72649e..4be819c5 100644 --- a/api/MathNet.Numerics/Evaluate.htm +++ b/api/MathNet.Numerics/Evaluate.htm @@ -328,7 +328,7 @@ Example: coefficients [3,-1,2] represent y=2x^2-x+3. diff --git a/api/MathNet.Numerics/ExcelFunctions.htm b/api/MathNet.Numerics/ExcelFunctions.htm index a08425e1..f9ad02af 100644 --- a/api/MathNet.Numerics/ExcelFunctions.htm +++ b/api/MathNet.Numerics/ExcelFunctions.htm @@ -412,7 +412,7 @@ porting over solutions previously implemented in Excel. diff --git a/api/MathNet.Numerics/FindMinimum.htm b/api/MathNet.Numerics/FindMinimum.htm index 1864c7b3..b61fa8e0 100644 --- a/api/MathNet.Numerics/FindMinimum.htm +++ b/api/MathNet.Numerics/FindMinimum.htm @@ -392,7 +392,7 @@ For more options and diagnostics consider to use -

    Based on v4.13.0.0 of MathNet.Numerics (Math.NET Numerics)

    +

    Based on v4.14.0.0 of MathNet.Numerics (Math.NET Numerics)

    Generated by docu

    diff --git a/api/MathNet.Numerics/FindRoots.htm b/api/MathNet.Numerics/FindRoots.htm index bc172895..10c7dfb3 100644 --- a/api/MathNet.Numerics/FindRoots.htm +++ b/api/MathNet.Numerics/FindRoots.htm @@ -421,7 +421,7 @@ Note the special coefficient order ascending by exponent (consistent with polyno diff --git a/api/MathNet.Numerics/Fit.htm b/api/MathNet.Numerics/Fit.htm index 2651ea2d..92ef9a35 100644 --- a/api/MathNet.Numerics/Fit.htm +++ b/api/MathNet.Numerics/Fit.htm @@ -623,7 +623,7 @@ returning a function y' for the best fitting line. diff --git a/api/MathNet.Numerics/Generate.htm b/api/MathNet.Numerics/Generate.htm index 6d488459..eff67a2e 100644 --- a/api/MathNet.Numerics/Generate.htm +++ b/api/MathNet.Numerics/Generate.htm @@ -1130,7 +1130,7 @@ Faster than other methods but with reduced guarantees on randomness. diff --git a/api/MathNet.Numerics/GoodnessOfFit.htm b/api/MathNet.Numerics/GoodnessOfFit.htm index 2a1101bc..07948087 100644 --- a/api/MathNet.Numerics/GoodnessOfFit.htm +++ b/api/MathNet.Numerics/GoodnessOfFit.htm @@ -381,7 +381,7 @@ number of samples is reduced for performing the Standard Error calculation

    diff --git a/api/MathNet.Numerics/IPrecisionSupport`1.htm b/api/MathNet.Numerics/IPrecisionSupport`1.htm index 4afa8b95..244917ec 100644 --- a/api/MathNet.Numerics/IPrecisionSupport`1.htm +++ b/api/MathNet.Numerics/IPrecisionSupport`1.htm @@ -297,7 +297,7 @@ appropriate for measuring how close together these two values are. diff --git a/api/MathNet.Numerics/Integrate.htm b/api/MathNet.Numerics/Integrate.htm index 8e24cb13..9bd6ae68 100644 --- a/api/MathNet.Numerics/Integrate.htm +++ b/api/MathNet.Numerics/Integrate.htm @@ -466,7 +466,7 @@ diff --git a/api/MathNet.Numerics/Interpolate.htm b/api/MathNet.Numerics/Interpolate.htm index 4a967a7f..a4ea9cf1 100644 --- a/api/MathNet.Numerics/Interpolate.htm +++ b/api/MathNet.Numerics/Interpolate.htm @@ -248,6 +248,7 @@
    +
    +
    Parameters
    + +
    IEnumerable<double> points
    +

    The sample points t.

    +
    IEnumerable<double> values
    +

    The sample point values x(t).

    +
    + +
    +
    Return
    +
    IInterpolation
    +

    An interpolation scheme optimized for the given sample points and values, +which can then be used to compute interpolations and extrapolations +on arbitrary points.

    +
    + + + +
    +

    IInterpolation CubicSplineMonotone(IEnumerable<double> points, IEnumerable<double> values)

    +
    Create a piecewise cubic monotone spline interpolation based on arbitrary points. +This is a shape-preserving spline with continuous first derivative.
    + if your data is already sorted in arrays, consider to use +MathNet.Numerics.Interpolation.CubicSpline.InterpolatePchipSorted +instead, which is more efficient. +
    + +
    Parameters
    @@ -326,7 +356,7 @@ on arbitrary points.

    IInterpolation CubicSplineRobust(IEnumerable<double> points, IEnumerable<double> values)

    -
    Create an piecewise cubic Akima spline interpolation based on arbitrary points. +
    Create a piecewise cubic Akima spline interpolation based on arbitrary points. Akima splines are robust to outliers.
    if your data is already sorted in arrays, consider to use MathNet.Numerics.Interpolation.CubicSpline.InterpolateAkimaSorted @@ -585,7 +615,7 @@ on arbitrary points.

    diff --git a/api/MathNet.Numerics/InvalidParameterException.htm b/api/MathNet.Numerics/InvalidParameterException.htm index 0c429c6e..88d2d812 100644 --- a/api/MathNet.Numerics/InvalidParameterException.htm +++ b/api/MathNet.Numerics/InvalidParameterException.htm @@ -416,7 +416,7 @@
    diff --git a/api/MathNet.Numerics/MemoryAllocationException.htm b/api/MathNet.Numerics/MemoryAllocationException.htm index 905c1137..85c2b6d6 100644 --- a/api/MathNet.Numerics/MemoryAllocationException.htm +++ b/api/MathNet.Numerics/MemoryAllocationException.htm @@ -406,7 +406,7 @@
    diff --git a/api/MathNet.Numerics/NativeInterfaceException.htm b/api/MathNet.Numerics/NativeInterfaceException.htm index 68cd3d0c..b9a5e581 100644 --- a/api/MathNet.Numerics/NativeInterfaceException.htm +++ b/api/MathNet.Numerics/NativeInterfaceException.htm @@ -381,7 +381,7 @@
    diff --git a/api/MathNet.Numerics/NonConvergenceException.htm b/api/MathNet.Numerics/NonConvergenceException.htm index 62101656..d372828c 100644 --- a/api/MathNet.Numerics/NonConvergenceException.htm +++ b/api/MathNet.Numerics/NonConvergenceException.htm @@ -416,7 +416,7 @@ diff --git a/api/MathNet.Numerics/NumericalBreakdownException.htm b/api/MathNet.Numerics/NumericalBreakdownException.htm index 34dd84c6..e8c6f7eb 100644 --- a/api/MathNet.Numerics/NumericalBreakdownException.htm +++ b/api/MathNet.Numerics/NumericalBreakdownException.htm @@ -416,7 +416,7 @@ diff --git a/api/MathNet.Numerics/Permutation.htm b/api/MathNet.Numerics/Permutation.htm index 03c64f9d..8237b97d 100644 --- a/api/MathNet.Numerics/Permutation.htm +++ b/api/MathNet.Numerics/Permutation.htm @@ -404,7 +404,7 @@ encoded using the array [22244]. diff --git a/api/MathNet.Numerics/Polynomial.htm b/api/MathNet.Numerics/Polynomial.htm index 621fe0d8..08f4538c 100644 --- a/api/MathNet.Numerics/Polynomial.htm +++ b/api/MathNet.Numerics/Polynomial.htm @@ -936,7 +936,7 @@ The null-polynomial returns degree -1 because the correct degree, negative infin diff --git a/api/MathNet.Numerics/Precision.htm b/api/MathNet.Numerics/Precision.htm index ccee5673..bbc640a6 100644 --- a/api/MathNet.Numerics/Precision.htm +++ b/api/MathNet.Numerics/Precision.htm @@ -2509,7 +2509,7 @@ On a standard machine this is equivalent to `PositiveDoublePrecision`. diff --git a/api/MathNet.Numerics/SingularUMatrixException.htm b/api/MathNet.Numerics/SingularUMatrixException.htm index 4810dace..63ac7c82 100644 --- a/api/MathNet.Numerics/SingularUMatrixException.htm +++ b/api/MathNet.Numerics/SingularUMatrixException.htm @@ -416,7 +416,7 @@ diff --git a/api/MathNet.Numerics/Sorting.htm b/api/MathNet.Numerics/Sorting.htm index 9b338ffa..bbfeaaa7 100644 --- a/api/MathNet.Numerics/Sorting.htm +++ b/api/MathNet.Numerics/Sorting.htm @@ -413,7 +413,7 @@ diff --git a/api/MathNet.Numerics/SpecialFunctions.htm b/api/MathNet.Numerics/SpecialFunctions.htm index ef3dac7c..587dd0a8 100644 --- a/api/MathNet.Numerics/SpecialFunctions.htm +++ b/api/MathNet.Numerics/SpecialFunctions.htm @@ -2515,7 +2515,7 @@ between 0 and 1.

    diff --git a/api/MathNet.Numerics/TestFunctions.htm b/api/MathNet.Numerics/TestFunctions.htm index d2ad06fb..0c7955f4 100644 --- a/api/MathNet.Numerics/TestFunctions.htm +++ b/api/MathNet.Numerics/TestFunctions.htm @@ -386,7 +386,7 @@ Common range: x in [-3,3], y in [-2,2].
    diff --git a/api/MathNet.Numerics/Trig.htm b/api/MathNet.Numerics/Trig.htm index 7f455d95..7367d71f 100644 --- a/api/MathNet.Numerics/Trig.htm +++ b/api/MathNet.Numerics/Trig.htm @@ -1403,7 +1403,7 @@ diff --git a/api/MathNet.Numerics/Window.htm b/api/MathNet.Numerics/Window.htm index 35f16681..fd942527 100644 --- a/api/MathNet.Numerics/Window.htm +++ b/api/MathNet.Numerics/Window.htm @@ -464,7 +464,7 @@ by half a cosine window on each side. diff --git a/api/MathNet.Numerics/index.htm b/api/MathNet.Numerics/index.htm index 868de15b..18c5abe9 100644 --- a/api/MathNet.Numerics/index.htm +++ b/api/MathNet.Numerics/index.htm @@ -282,7 +282,7 @@ diff --git a/api/index.htm b/api/index.htm index 684d68f0..68584c58 100644 --- a/api/index.htm +++ b/api/index.htm @@ -393,7 +393,7 @@

    Math.NET Numerics Documentation