ComplexMatrixDense(Int32, Int32, Complex) Method

Creates a dense ComplexMatrix instance having the specified size, and assigns the same value to each matrix entry.

Definition

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.1.0+428f3840cfab98dda567bb0ed350b302533e273a

C#

public static ComplexMatrix Dense(
	int numberOfRows,
	int numberOfColumns,
	Complex data
)

VB

Public Shared Function Dense ( 
	numberOfRows As Integer,
	numberOfColumns As Integer,
	data As Complex
) As ComplexMatrix

C++

public:
static ComplexMatrix^ Dense(
	int numberOfRows, 
	int numberOfColumns, 
	Complex data
)

F#

static member Dense : 
        numberOfRows : int * 
        numberOfColumns : int * 
        data : Complex -> ComplexMatrix

Parameters

numberOfRows Int32: The number of matrix rows.
numberOfColumns Int32: The number of matrix columns.
data Complex: The value assigned to each matrix entry.

Return Value

ComplexMatrix
The matrix having the specified size and data.

Remarks

ComplexMatrix dense instances allocate storage for each matrix entry. Sparse ComplexMatrix instances can be created by calling method Sparse(Int32, Int32, Int32).

Example

In the following example, a dense matrix is created having all its entries equal to a given value.

Creation of a dense matrix with all entries equal to a given value

using System;
using System.Numerics;

namespace Novacta.Analytics.CodeExamples
{
    public class ComplexDenseExample4  
    {
        public void Main()
        {
            // Set matrix dimensions.
            int numberOfRows = 3;
            int numberOfColumns = 2;

            // Set the value for each entry.
            Complex data = new(1, -1);

            // Create the matrix. All entries will be equal to the
            // same value.
            var matrix = ComplexMatrix.Dense(
                numberOfRows, numberOfColumns, data);
            Console.WriteLine("Each entry is equal to the same value.");
            Console.WriteLine("The data matrix:");
            Console.WriteLine(matrix);
        }
    }
}

// Executing method Main() produces the following output:
// 
// Each entry is equal to the same value.
// The data matrix:
// (                1,               -1) (                1,               -1) 
// (                1,               -1) (                1,               -1) 
// (                1,               -1) (                1,               -1) 
// 
//

Exceptions

ArgumentOutOfRangeException

numberOfRows is not positive.
-or-
numberOfColumns is not positive.