BlockVector<T>.AddScaledInPlace Method

Adds a scaled vector to this instance.

Definition

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

public override Vector<T> AddScaledInPlace(
	T factor,
	Vector<T> vector
)

Visual Basic

Public Overrides Function AddScaledInPlace ( 
	factor As T,
	vector As Vector(Of T)
) As Vector(Of T)

C++/CLI

public:
virtual Vector<T>^ AddScaledInPlace(
	T factor, 
	Vector<T>^ vector
) override

abstract AddScaledInPlace : 
        factor : 'T * 
        vector : Vector<'T> -> Vector<'T> 
override AddScaledInPlace : 
        factor : 'T * 
        vector : Vector<'T> -> Vector<'T>

Parameters

factor T: The scale factor.
vector Vector<T>: The vector to add.

Return Value

Vector<T>
A reference to this vector.

Remarks

Using this method is more efficient than evaluating the equivalent expression using overloaded operators. In the latter case, two intermediate vectors are created. This method doesn't create any intermediate vectors.

Exceptions

ArgumentNullException	vector is null.
DimensionMismatchException	The length of vector does not equal the length of this instance.
ComponentReadOnlyException	An attempt is made to modify a component of a fixed BlockVector<T>.