///
///    This file is part of ILNumerics Community Edition.
///
///    ILNumerics Community Edition - high performance computing for applications.
///    Copyright (C) 2006 - 2012 Haymo Kutschbach, http://ilnumerics.net
///
///    ILNumerics Community Edition is free software: you can redistribute it and/or modify
///    it under the terms of the GNU General Public License version 3 as published by
///    the Free Software Foundation.
///
///    ILNumerics Community Edition is distributed in the hope that it will be useful,
///    but WITHOUT ANY WARRANTY; without even the implied warranty of
///    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
///    GNU General Public License for more details.
///
///    You should have received a copy of the GNU General Public License
///    along with ILNumerics Community Edition. See the file License.txt in the root
///    of your distribution package. If not, see <http://www.gnu.org/licenses/>.
///
///    In addition this software uses the following components and/or licenses: 
///
///    =================================================================================
///    The Open Toolkit Library License
///    
///    Copyright (c) 2006 - 2009 the Open Toolkit library.
///    
///    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.
///
///    =================================================================================
///    

using System;
using System.Collections.Generic;
using System.Text;
using ILNumerics.Storage;
using ILNumerics.Misc;
using ILNumerics.Exceptions; 

namespace ILNumerics  {
    public partial class ILMath {

        /// <summary>
        /// Load single array from matfile file
        /// </summary>
        /// <typeparam name="T">Element type of the array to return</typeparam>
        /// <param name="filename">Path of the matfile on disk</param>
        /// <param name="arrayname">[Optional] name of the requested array in the matfile (default: empty string)</param>
        /// <returns>The array requested</returns>
        /// <remarks><para>If the matfile contains only one array, the <paramref name="arrayname"/> may
        /// be ommited. The only array is returned than.</para></remarks>
        public static ILRetArray<T> loadArray<T>(string filename, string arrayname = "") {
            using (ILScope.Enter()) {
                using (ILMatFile matfile = new ILMatFile(filename)) {
                    if (String.IsNullOrEmpty(arrayname) && matfile.Count == 1) {
                        return matfile.GetArray<T>(0);
                    } else {
                        return matfile.GetArray<T>(arrayname); 
                    }
                }
            }
        }

    }
}