mathnet-numerics/src/Data/Matlab/MatlabReader.cs

// <copyright file="MatlabReader.cs" company="Math.NET">
// Math.NET Numerics, part of the Math.NET Project
// http://numerics.mathdotnet.com
// http://github.com/mathnet/mathnet-numerics
// http://mathnetnumerics.codeplex.com
//
// Copyright (c) 2009-2014 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
// </copyright>

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using MathNet.Numerics.LinearAlgebra;

namespace MathNet.Numerics.Data.Matlab
{
    /// <summary>
    /// Creates matrices from MATLAB files.
    /// </summary>
    public static class MatlabReader
    {
        /// <summary>
        /// List all compatible matrices from a MATLAB file stream.
        /// </summary>
        public static List<MatlabMatrix> ListMatrices(Stream stream)
        {
            return Parser.ParseAll(stream);
        }

        /// <summary>
        /// List all compatible matrices from a MATLAB file.
        /// </summary>
        public static List<MatlabMatrix> ListMatrices(string filePath)
        {
            using (var stream = File.OpenRead(filePath))
            {
                return Parser.ParseAll(stream);
            }
        }

        /// <summary>
        /// Read the first or a specific matrix from a MATLAB file stream.
        /// </summary>
        /// <typeparam name="TDataType">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
        public static Matrix<TDataType> ReadMatrix<TDataType>(Stream stream, string matrixName = null)
            where TDataType : struct, IEquatable<TDataType>, IFormattable
        {
            var matrices = Parser.ParseAll(stream);

            if (string.IsNullOrEmpty(matrixName))
            {
                return Parser.ReadMatrixBlock<TDataType>(matrices.First().Data);
            }

            var matrix = matrices.Find(m => m.Name == matrixName);
            if (matrix == null)
            {
                throw new KeyNotFoundException("Matrix with the provided name was not found.");
            }

            return Parser.ReadMatrixBlock<TDataType>(matrix.Data);
        }

        /// <summary>
        /// Read the first or a specific matrix from a MATLAB file.
        /// </summary>
        /// <typeparam name="TDataType">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
        public static Matrix<TDataType> ReadMatrix<TDataType>(string filePath, string matrixName = null)
            where TDataType : struct, IEquatable<TDataType>, IFormattable
        {
            using (var stream = File.OpenRead(filePath))
            {
                return ReadMatrix<TDataType>(stream, matrixName);
            }
        }

        /// <summary>
        /// Read the matrix of a MATLAB matrix data object.
        /// </summary>
        /// <typeparam name="TDataType">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
        public static Matrix<TDataType> ReadMatrix<TDataType>(MatlabMatrix matrixData)
            where TDataType : struct, IEquatable<TDataType>, IFormattable
        {
            return Parser.ReadMatrixBlock<TDataType>(matrixData.Data);
        }

        /// <summary>
        /// Read all matrices or those with matching name from a MATLAB file stream.
        /// </summary>
        /// <typeparam name="TDataType">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
        public static Dictionary<string, Matrix<TDataType>> ReadMatrices<TDataType>(Stream stream, params string[] matrixNames)
            where TDataType : struct, IEquatable<TDataType>, IFormattable
        {
            var names = new HashSet<string>(matrixNames);
            return Parser.ParseAll(stream)
                .Where(m => names.Count == 0 || names.Contains(m.Name))
                .ToDictionary(m => m.Name, m => Parser.ReadMatrixBlock<TDataType>(m.Data));
        }

        /// <summary>
        /// Read all matrices or those with matching name from a MATLAB file.
        /// </summary>
        /// <typeparam name="TDataType">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
        public static Dictionary<string, Matrix<TDataType>> ReadMatrices<TDataType>(string filePath, params string[] matrixNames)
            where TDataType : struct, IEquatable<TDataType>, IFormattable
        {
            using (var stream = File.OpenRead(filePath))
            {
                return ReadMatrices<TDataType>(stream, matrixNames);
            }
        }
    }
}