.NET Matrix Library
ToString(String) Method
See Also  Example Send Feedback



format
A format string that will be used to convert all matrix elements.
Converts this instance of Matrix to a formatted string specifying a format string, and using the default values for separator, left and right borders, and end of line characters.

Syntax

Visual Basic (Declaration) 
Public Overloads Function ToString( _
   ByVal format As String _
) As String
Visual Basic (Usage)Copy Code
Dim instance As Matrix
Dim format As String
Dim value As String
 
value = instance.ToString(format)
C# 
public string ToString( 
   string format
)
C++/CLI 
public:
String^ ToString( 
   String^ format
) 

Parameters

format
A format string that will be used to convert all matrix elements.

Return Value

A formatted string containing all matrix elements.

Example

The following example demonstrates the use of FillRandom and ToString methods.
Visual BasicCopy Code
Imports System
Imports Bluebit.MatrixLibrary

Class Test

    Public Shared Sub Main()

        'Declaring a 4x4 Matrix
        Dim A As New Matrix(4, 4)
        'Fill matrix A with random values from 0 to 10
        A.FillRandom()
        'Print the matrix using the default format
        Console.WriteLine(A)
        'Print the matrix with 0 decimal digits
        Console.WriteLine(A.ToString("F0"))

        'Fill matrix with random values ranging from 
        ' - 100 to 100 with 3 decimals
        A.FillRandom(-10000, 10000, 3)
        'Print the matrix with 2 decimal digits
        Console.WriteLine(A.ToString("F2"))
        'Print the matrix in scientific format 3 decimals
        Console.WriteLine(A.ToString("E3"))
        'Print the matrix in roundtrip format and in array declaration style
        Console.WriteLine(A.ToString("R", ",", "{", "}," + vbCrLf, "}" + vbCrLf))
        'Print the matrix using a different culture info (Italian)
        Dim cInfo As System.Globalization.CultureInfo = New System.Globalization.CultureInfo("it-IT")
        Console.WriteLine(A.ToString(cInfo, "N"))

        Console.Read()
    End Sub

End Class
C#Copy Code
using System;
using Bluebit.MatrixLibrary;

class Test
{
    static void Main(string[] args)
    {
        //Declaring a 4x4 Matrix 
        Matrix A = new Matrix(4, 4);
        //Fill matrix A with random values from 0 to 10
        A.FillRandom();
        //Print the matrix using the default format
        Console.WriteLine(A);
        //Print the matrix with 0 decimal digits
        Console.WriteLine(A.ToString("F0"));

        //Fill matrix with random values ranging from 
        // - 10000 to 10000 with 3 decimals
        A.FillRandom(-10000, 10000, 3);
        //Print the matrix with 2 decimal digits
        Console.WriteLine(A.ToString("F2"));
        //Print the matrix in scientific format with 3 decimals
        Console.WriteLine(A.ToString("E3"));
        //Print the matrix in roundtrip format and in array declaration style
        Console.WriteLine(A.ToString("R", ",", "{", "},\n", "}\n"));
        //Print the matrix using a different culture info (Italian)
        System.Globalization.CultureInfo cInfo = new System.Globalization.CultureInfo("it-IT");
        Console.WriteLine(A.ToString(cInfo, "N"));

        Console.Read();
    }
}
C++Copy Code
#include "stdafx.h"

using namespace System;
using namespace Bluebit::MatrixLibrary;

int main(array<System::String ^> ^args)
{
    //Declaring a 4x4 Matrix  
    Matrix^ A = gcnew Matrix(4, 4);
    //Fill matrix A with random values from 0 to 10
    A->FillRandom();
    //Print the matrix using the default format
    Console::WriteLine(A);
    //Print the matrix with 0 decimal digits
    Console::WriteLine(A->ToString("F0"));

    //Fill matrix with random values ranging from 
    // - 10000 to 10000 with 3 decimals
    A->FillRandom(-10000, 10000, 3);
    //Print the matrix with 2 decimal digits
    Console::WriteLine(A->ToString("F2"));
    //Print the matrix in scientific format with 3 decimals
    Console::WriteLine(A->ToString("E3"));
    //Print the matrix in roundtrip format and in array declaration style
    Console::WriteLine(A->ToString("R", ",", "{", "},\n", "}\n"));
    //Print the matrix using a different culture info (Italian)
    System::Globalization::CultureInfo^  cInfo = gcnew System::Globalization::CultureInfo("it-IT");
    Console::WriteLine(A->ToString(cInfo, "N"));

    Console::Read();
    
	return 0;
}

Remarks

A space character is used as a separator of matrix elements. The left and right borders are set to "| " and " |" strings respectively. The new line character "\n" is added after each matrix row.

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Vista, Windows Server 2008 family, Windows 7

See Also

.NET Matrix Library