MathWorks.MATLAB.NET.Arrays.MWLogicalArray Class

Namespace: MathWorks.MATLAB.NET.Arrays

Managed representation of MATLAB logical array

Description

MWLogicalArray is the managed representation of the MATLAB logical array. Like its MATLAB equivalent, an MWLogicalArray contains only ones and zeros (true/false).

As MWLogicalArray is derived from MWIndexArray, it can be used in all MATLAB indexing operations.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Properties

Public Properties

ArrayType — Derived type of MWArray

MWArrayType

This property is read-only.

Syntax

public MWArrayType ArrayType { get; }

The derived type of the array, specified as an MWArrayType object.

Dimensions — Return native integer array containing size of each dimension of MWArray

positive integer

This property is read-only.

Syntax

public virtual int[] Dimensions { get; }

See size.

Empty — Return writeable version of empty MWLogicalArray

MWLogicalArray

This property is read-only.

Syntax

public static MWLogicalArray Empty { get; }

IsCellArray — Flag indicating if MWArray is MWCellArray

boolean

This property is read-only.

Syntax

public bool IsCellArray { get; }

See iscell.

IsCharArray — Flag indicating if MWArray is MWCharArray

boolean

This property is read-only.

Syntax

public bool IsCharArray { get; }

See ischar.

IsDisposed — Handle status of encapsulated MWArray

boolean

This property is read-only.

Syntax

public virtual bool IsDisposed { get; }

IsEmpty — Flag indicating if MWArray is empty

boolean

This property is read-only.

Syntax

public virtual bool IsEmpty { get; }

See isempty.

IsLogicalArray — Flag indicating if MWArray is MWLogicalArray

boolean

This property is read-only.

Syntax

public bool IsLogicalArray { get; }

See islogical.

IsNumericArray — Flag indicating if MWArray is MWNumericArray

boolean

This property is read-only.

Syntax

public bool IsNumericArray { get; }

See isnumeric.

IsScalar — Return true of array is logical scalar

boolean

This property is read-only.

Syntax

public bool IsScalar { get; }

IsSparse — Return true of array is sparse array

boolean

This property is read-only.

Syntax

public bool IsSparse { get; }

.

IsStringArray — Flag indicating if MWArray is MWStringArray

boolean

This property is read-only.

Syntax

public bool IsStringArray { get; }

See isstring.

IsStructArray — Flag indicating if MWArray is MWStructArray

boolean

This property is read-only.

Syntax

public bool IsStructArray { get; }

See isstruct.

Item — Generic MATLAB indexer returning result as MWArray

MWArray

Syntax

public MWArray this[
	params int[] indices
] { get; set; }

An index can be any number of integers corresponding to the array's dimensions. As with MATLAB, a single index will return the nth element in the array. NOTE: The generic array indexer supports numeric, logical, char, and cell array types. For complex numeric arrays, both the real and the imaginary components are returned.

Array indexing in this API, as in MATLAB^®, is one-based rather than zero-based.

NonZeroMaxStorage — Return number of storage locations allocated for nonzero elements of sparse matrix

Int32

Syntax

public int NonZeroMaxStorage { get; }

For a full matrix, NZMAX(S) is equivalent to prod(size(S)). See nzmax function in the MATLAB documentation.

NumberOfDimensions — Number of dimensions in MWArray

positive integer

This property is read-only.

Syntax

public int NumberofDimensions { get; }

See ndims.

NumberOfElements — Number of elements in MWArray

positive integer

This property is read-only.

Syntax

public int NumberOfElements { get; }

Equivalent to prod(size(A)) for non-empty arrays. See numel.

Methods

Constructors

These methods specialize standard MATLAB operators and functions for objects in this class.

MWLogicalArray()	Syntax public MWLogicalArray() Creates an empty logical array
MWLogicalArray(Array)	Syntax public MWCharArray( Array stringArray ) Constructs an m-by-n-by-p-by-... logical array from a native array of boolean values. Parameters boolArray Type: System.Array A native boolean array. The logical array will have the same dimensions and values as the native array. NOTE: As MATLAB arrays must have at least two dimensions, a single dimension native array will result in the creation of a two dimensional logical array having a single row.
MWLogicalArray(Boolean)	Syntax public MWLogicalArray( bool logicalValue ) Creates a logical scalar array representing the specified boolean value. Parameters value Type: System.Boolean A boolean value.
MWLogicalArray(Int32[])	Syntax public MWLogicalArray( params int[] dimensions ) Creates an m-by-n-by-p-by-... empty logical array. Parameters value Type: System.Int32[] A number of array dimensions. If only one dimension is specified, an empty n-by-n logical array is created.
MWLogicalArray(Int32, Int32)	Syntax public MWLogicalArray( int row, int column ) Creates an empty m-by-n logical array. Parameters row Type: System.Int32 The number of rows in the array column Type: System.Int32 The number of columns in the array
MWLogicalArray(SerializationInfo, Streaming,Context)	Syntax protected MWLogicalArray( SerializationInfo serializationInfo, StreamingContext context ) Internal deserialization constructor. Parameters serializationInfo Type: System.Runtime.Serialization.SerializationInfo Holds the data needed to serialize or deserialize the object. context Type: System.Runtime.Serialization.StreamingContext Describes the source and destination of the serialized stream
MWLogicalArray(Int32, Int32, Boolean[])	Syntax public MWLogicalArray( int rows, int columns, bool[] boolArray ) Constructs an m-by-n logical array initialized to the values contained in a native boolean array. Parameters row Type: System.Int32 The number of rows in the array column Type: System.Int32 The number of columns in the array boolArray Type: System.Boolean[] A native vector of boolean values The logical array is initialized in row major order from the values contained in the boolean vector. The number of elements in the vector array must match the number of elements in the newly created logical array (rows * columns).
MWLogicalArray(Int32, Int32, Boolean[], Boolean)	Syntax public MWLogicalArray( int rows, int columns, bool[] boolArray, bool columnMajorOrder ) Constructs an m-by-n logical array initialized to the values contained in a native boolean array. Internal deserialization constructor. Parameters row Type: System.Int32 The number of rows in the array column Type: System.Int32 The number of columns in the array boolArray Type: System.Boolean[] A native vector of boolean values columnMajorOrder Type: System.Boolean A boolean flag - true if the logical array should be initialized in column major order. The logical array is initialized in the specified order from the values contained in the boolean array. The number of elements in the array must match the number of elements in the newly created logical array (rows * columns).

Public Methods

Clone	Syntax public virtual Object Clone() Makes a deep copy of an MWArray. See the "=" operator in the MATLAB documentation.
ConvertToNativeTypes	Syntax public static Object[] ConvertToNativeTypes( MWArray[] src, Type[] specifiedTypes ) Converts an array of MWArray to types specified by user. Returns an object array with the converted types on success, otherwise throws an ArgumentException. This method should only be called from the generated implementation.
Dispose()	Syntax public void Dispose() Releases resources of the MWArray and the native mxArray that it encapsulates. This method allows for the explicit lifecycle control of an MWArray and its native MATLAB array.
Dispose(Boolean)	Syntax protected override void Dispose( bool disposing ) Parameters disposing Type: System.Boolean Client explicit dispose flag Internal dispose function
Equals	Syntax public override bool Equals( Objectobj ) Compares two MWArray instances for equality. Returns true if both arrays are equal.
Finalize	Inherited from Object
GetHashCode	Syntax public override int GetHashCode() Returns the hashcode of the MWArray.
GetObjectData	Syntax public virtual void GetObjectData( SerializationInfo info, StreamingContext context ) Parameters info Type: System.Runtime.Serialization.SerializationInfo Holds the data needed to serialize or deserialize the object. context Type: System.Runtime.Serialization.StreamingContext Describes the source and destination of the serialized stream. Implements ISerializable.GetObjectData(SerializationInfo, StreamingContext) Serialization function. The arguments for this function are supplied by the .NET serialization infrastructure.
GetType	Inherited from Object
MakeSparse(Int32, Int32, Int32)	Syntax public static MWLogicalArray MakeSparse( int rows, int columns, int nonZeroMax ) Parameters Rows Type: System.Int32 Number of rows in the sparse matrix Columns Type: System.Int32 Number of columns in the sparse matrix nonZeroMax Type: System.Int32 Maximum number of nonzero elements in the sparse matrix Return Value Type: MWLogicalArray The sparse logical matrix Constructs a sparse logical matrix with the specified rows and columns and storage for the specified number of non-zero elements.
MakeSparse(Int32[],Int32[],Boolean[])	Syntax publicstaticMWLogicalArrayMakeSparse( int[] rowIndex, int[] columnIndex, bool[] dataArray ) Parameters rowIndex Type: System.Int32[] An array of 1-based row indices columnIndex Type: System.Int32[] An array of 1-based column indices dataArray Type: System.boolean[] The logical data array for the sparse matrix Return Value Type: MWLogicalArray The sparse logical matrix Constructs a logical sparse matrix with the number of rows= max{rowIndex(k)} and the number of columns= max{colIndex(k)}. It initializes the array with the supplied data. The maximum number of nonzero elements is equal to the length of the data array. The row and column index arrays are used to construct the sparse array such that S(rowIndex(k), columnIndex(k))= dataArray(k).
MakeSparse(Int32, Int32,Int32[],Int32[],Boolean[])	Syntax publicstaticMWLogicalArrayMakeSparse( int[] rowIndex, int[] columnIndex, bool[] dataArray ) Parameters rows Type: System.Int32 Number of rows in sparse matrix columns Type: System.Int32 Number of columns in sparse matrix rowIndex Type: System.Int32[] An array of 1-based row indices columnIndex Type: System.Int32[] An array of 1-based column indices dataArray Type: System.boolean[] The logical data array for the sparse matrix Return Value Type: MWLogicalArray The sparse logical matrix The row and column index arrays are used to construct the sparse array such that S(rowIndex(k), columnIndex(k))= dataArray(k).
MakeSparse(Int32, Int32,Int32[],Int32[],Boolean[], Int32)	Syntax publicstaticMWLogicalArrayMakeSparse( int[] rowIndex, int[] columnIndex, bool[] dataArray ) Parameters rows Type: System.Int32 Number of rows in sparse matrix columns Type: System.Int32 Number of columns in sparse matrix rowIndex Type: System.Int32[] An array of 1-based row indices columnIndex Type: System.Int32[] An array of 1-based column indices dataArray Type: System.boolean[] The logical data array for the sparse matrix nonZeroMax Type: System.Int32 Maximum number of nonzero elements in the sparse matrix Return Value Type: MWLogicalArray The sparse logical matrix The row and column index arrays are used to construct the sparse array such that S(rowIndex(k), columnIndex(k))= dataArray(k).
MemberwiseClone	Inherited from Object
ToArray	Syntax public virtual Array ToArray() Returns a native .NET array containing a copy of data in the underlying MATLAB array. The returned array has the same dimensionality as the underlying MATLAB array. The elements of the returned array are converted according to default conversion rules. If the underlying MATLAB array is a complex numeric type, toArray throws an exception. If the underlying array is sparse, a full representation of the array is returned. Care should be taken when calling toArray on a sparse array with large row and column dimensions, as this action may exhaust system memory. If the underlying array is a cell or struct array, toArray is recursively called on each cell.
ToString	Syntax public virtual string ToString() Returns a formatted string representing the contents of the MWArray
ToVector	Syntax public bool[] ToVector() Returns a copy of the elements in the logical array as a one dimension native boolean array The data is returned as a native array in the standard MATLAB column major order not the C# row major order.

Specialized Operators and Functions

These methods specialize standard MATLAB operators and functions for objects in this class.

Implicit(Double to MWLogicalArray)	Implicit cast from native double scalar value to MWNumericArray
Implicit(String to MWLogicalArray)	Implicit cast from native character string to MWCharArray

Inheritance Hierarchy

System.Object

• Mathworks.MATLAB.NET.Arrays.MWArray

  • Mathworks.MATLAB.NET.Arrays.MWIndexArray

    • Mathworks.MATLAB.NET.Arrays.MWLogicalArray

    • Mathworks.MATLAB.NET.Arrays.MWNumericArray

Version History

Introduced in R2006a