///
///    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.Linq;
using System.Text;
using ILNumerics.Misc; 
using System.Linq.Expressions; 

namespace ILNumerics {
    // ToDo: DOKU add example
    public partial class ILMath {

        private static ILExpression s_end = new ILExpression(Expression.Parameter(typeof(int), "end")); 
        
        /// <summary>
        /// Substitute for the index of the last element of a dimension
        /// </summary>
        /// <remarks>The 'end' placeholder can be used in subarray specification expressions. It will get 
        /// evaluated in a delayed manner, once the index of the dimension (and therefore the dimension length)
        /// is known. It than evaluates to the number of the index of the last element in the dimension.
        /// </remarks>
        public static ILExpression end { 
            get {
                if (object.Equals(s_end, null) || s_end.IsDisposed) {
                    s_end = new ILExpression(Expression.Parameter(typeof(int), "end")); 
                }
                return s_end; 
            }
        }

    }
}