Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Problems.GaussianProcessTuning/ILNumerics.2.14.4735.573/Functions/builtin/check.cs @ 9407

Last change on this file since 9407 was 9102, checked in by gkronber, 12 years ago

#1967: ILNumerics source for experimentation

File size: 7.4 KB
Line 
1///
2///    This file is part of ILNumerics Community Edition.
3///
4///    ILNumerics Community Edition - high performance computing for applications.
5///    Copyright (C) 2006 - 2012 Haymo Kutschbach, http://ilnumerics.net
6///
7///    ILNumerics Community Edition is free software: you can redistribute it and/or modify
8///    it under the terms of the GNU General Public License version 3 as published by
9///    the Free Software Foundation.
10///
11///    ILNumerics Community Edition is distributed in the hope that it will be useful,
12///    but WITHOUT ANY WARRANTY; without even the implied warranty of
13///    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14///    GNU General Public License for more details.
15///
16///    You should have received a copy of the GNU General Public License
17///    along with ILNumerics Community Edition. See the file License.txt in the root
18///    of your distribution package. If not, see <http://www.gnu.org/licenses/>.
19///
20///    In addition this software uses the following components and/or licenses:
21///
22///    =================================================================================
23///    The Open Toolkit Library License
24///   
25///    Copyright (c) 2006 - 2009 the Open Toolkit library.
26///   
27///    Permission is hereby granted, free of charge, to any person obtaining a copy
28///    of this software and associated documentation files (the "Software"), to deal
29///    in the Software without restriction, including without limitation the rights to
30///    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
31///    the Software, and to permit persons to whom the Software is furnished to do
32///    so, subject to the following conditions:
33///
34///    The above copyright notice and this permission notice shall be included in all
35///    copies or substantial portions of the Software.
36///
37///    =================================================================================
38///   
39
40using System;
41using System.Collections.Generic;
42using System.Text;
43using ILNumerics.Storage;
44using ILNumerics.Misc;
45using ILNumerics.Exceptions;
46
47namespace ILNumerics {
48    public partial class ILMath {
49
50        /// <summary>
51        /// Check if A is a valid parameter
52        /// </summary>
53        /// <typeparam name="T">Element type</typeparam>
54        /// <param name="A">Input parameter</param>
55        /// <param name="ErrorMessage">[optional] Exception message</param>
56        /// <param name="evaluation">[optional] Evaluation function, checks input parameter and transforms it into result, gets only called for A other than null</param>
57        /// <param name="allowNullInput">[optional] Only if A is null -> for true: returns null, false: throws exception. If <paramref name="Default"/> was defined, this parameter is ignored.</param>
58        /// <param name="Default">[optional] If <paramref name="A"/> is null on input, this value is returned. If no default is given (i.e: null), <paramref name="allowNullInput"/> is evaluated.</param>
59        /// <returns>Result of evaluation(A) or A</returns>
60        /// <exception cref="ILNumerics.Exceptions.ILArgumentException">If A was null on entry and <paramref name="allowNullInput"/> is false</exception>
61        public static ILRetArray<T> check<T>(ILInArray<T> A, Func<ILInArray<T>, ILRetArray<T>> evaluation = null, bool allowNullInput = false, string ErrorMessage = "", ILInArray<T> Default = null) {
62            using (ILScope.Enter(A,Default)) {
63                if (object.Equals(A, null)) {
64                    if (isnull(Default)) {
65                        if (!allowNullInput)
66                            throw new ILArgumentException("an input parameter was found to be null");
67                        else
68                            return null;
69                    } else {
70                        return Default.C;
71                    }
72                }
73                if (evaluation == null)
74                    return A;
75                ILRetArray<T> ret = evaluation(A);
76                if (object.Equals(ret, null))
77                    throw new ILArgumentException(String.IsNullOrEmpty(ErrorMessage) ? "invalid input parameter. check the documentation!" : ErrorMessage);
78                else
79                    return ret;
80            }
81        }
82        /// <summary>
83        /// Check if A is a valid parameter
84        /// </summary>
85        /// <param name="A">Input parameter</param>
86        /// <param name="ErrorMessage">[optional] Exception message</param>
87        /// <param name="evaluation">[optional] Evaluation function, checks input parameter and transforms it into result, gets only called for A other than null</param>
88        /// <param name="allowNullInput">[optional] Only if A is null -> for true: returns null, false: throws exception</param>
89        /// <returns>Result of evaluation(A) or A</returns>
90        /// <exception cref="ILNumerics.Exceptions.ILArgumentException">If A was null on entry and <paramref name="allowNullInput"/> is false</exception>
91        public static ILRetLogical check(ILInLogical A, Func<ILInLogical, ILRetLogical> evaluation = null, bool allowNullInput = false, string ErrorMessage = "") {
92            using (ILScope.Enter(A)) {
93                if (object.Equals(A, null)) {
94                    if (!allowNullInput)
95                        throw new ILArgumentException("an input parameter was found to be null");
96                    else
97                        return null;
98                }
99                if (evaluation == null)
100                    return A;
101                ILRetLogical ret = evaluation(A);
102                if (object.Equals(ret, null))
103                    throw new ILArgumentException(String.IsNullOrEmpty(ErrorMessage) ? "invalid input parameter. check the documentation!" : ErrorMessage);
104                else
105                    return ret;
106            }
107        }
108        /// <summary>
109        /// Check if A is a valid parameter
110        /// </summary>
111        /// <param name="A">Input parameter</param>
112        /// <param name="ErrorMessage">[Optional] Exception message</param>
113        /// <param name="evaluation">[Optional] Evaluation function, checks input parameter and transforms it into result, gets only called for A other than null</param>
114        /// <param name="allowNullInput">[Optional] Only if A is null -> true: returns null, false: throws exception</param>
115        /// <returns>Result of evaluation(A) or A</returns>
116        /// <exception cref="ILNumerics.Exceptions.ILArgumentException">If A was null on entry and <paramref name="allowNullInput"/> is false</exception>
117        public static ILRetCell check(ILInCell A, Func<ILInCell, ILRetCell> evaluation = null, bool allowNullInput = false, string ErrorMessage = "") {
118            using (ILScope.Enter(A)) {
119                if (object.Equals(A, null)) {
120                    if (!allowNullInput)
121                        throw new ILArgumentException("an input parameter was null");
122                    else
123                        return null;
124                }
125                if (evaluation == null)
126                    return A;
127                ILRetCell ret = evaluation(A);
128                if (object.Equals(ret, null))
129                    throw new ILArgumentException(String.IsNullOrEmpty(ErrorMessage) ? "invalid input parameter. check the documentation!" : ErrorMessage);
130                else
131                    return ret;
132            }
133        }
134    }
135}
Note: See TracBrowser for help on using the repository browser.