Matrix<T>.TryEnsureWritable Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0

Overload List

TryEnsureWritable() Ensures that the elements of the matrix can be written to.
TryEnsureWritable(Int32, Int32)Checked compatibility wrapper for writability preparation.
Obsolete
TryEnsureWritable(Int32, Int32, Int32, Int32)Checked compatibility wrapper for writability preparation.
Obsolete

TryEnsureWritable

Ensures that the elements of the matrix can be written to.
C# 
public virtual bool TryEnsureWritable()

Return Value

Boolean

true if the operation succeeded; otherwise false.

Remarks

A zero-length dimension has the canonical whole range from zero through -1.

A mutable matrix with an empty write footprint succeeds without preparing or detaching storage. A read-only empty matrix remains nonwritable.

TryEnsureWritable(Int32, Int32)

Note: This API is now obsolete.
Checked compatibility wrapper for writability preparation.
C# 
[ObsoleteAttribute("Use the corresponding Unchecked method. The suffix-less writability APIs are retained as checked compatibility wrappers.", 
	false)]
public bool TryEnsureWritable(
	int row,
	int column
)

Parameters

row  Int32
 
column  Int32
 

Return Value

Boolean

TryEnsureWritable(Int32, Int32, Int32, Int32)

Note: This API is now obsolete.
Checked compatibility wrapper for writability preparation.
C# 
[ObsoleteAttribute("Use the corresponding Unchecked method. The suffix-less writability APIs are retained as checked compatibility wrappers.", 
	false)]
public bool TryEnsureWritable(
	int startRow,
	int endRow,
	int startColumn,
	int endColumn
)

Parameters

startRow  Int32
 
endRow  Int32
 
startColumn  Int32
 
endColumn  Int32
 

Return Value

Boolean

See Also