Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Problems.GaussianProcessTuning/ILNumerics.2.14.4735.573/Functions/builtin/cart2pol.cs @ 11316

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

#1967: ILNumerics source for experimentation

File size: 4.7 KB
RevLine 
[9102]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.Linq;
43using System.Text;
44
45namespace ILNumerics {
46
47    // ToDo: DOKU remarks and returns seem outdated...
48    public partial class ILMath {
49
50        /// <summary>
51        /// Transform scalar coordinates into polar (cylindrical) coordinates
52        /// </summary>
53        /// <param name="X">X coordinates</param>
54        /// <param name="Y">Y coordinates</param>
55        /// <param name="Z">Z coordinates (height)</param>
56        /// <param name="outRadius">[Output] Radius if not null on entry</param>
57        /// <param name="outZ">[Output] Z if not null on entry</param>
58        /// <returns>Angles; radius and Z are returned as output parameters, if on entry not null</returns>
59        /// <remarks>Theta, radius and Z must be the same size or either one may be scalar.
60        /// Polar coordinate arrays returned are of the same size then the input arrays.</remarks>
61        public static ILRetArray<double> cart2pol(ILInArray<double> X, ILInArray<double> Y, ILInArray<double> Z
62                                        ,ILOutArray<double> outRadius, ILOutArray<double> outZ) {
63            using (ILScope.Enter(X,Y,Z)) {   
64                if (!object.Equals(outRadius, null))
65                    outRadius.a = sqrt(X * X + Y * Y);
66                if (!object.Equals(outZ,null))
67                    outZ.a = Z.C;
68                return atan2(Y,X);
69            }
70        }
71
72        /// <summary>
73        /// Transform scalar coordinates into polar (cylindrical) coordinates
74        /// </summary>
75        /// <param name="X">X coordinates</param>
76        /// <param name="Y">Y coordinates</param>
77        /// <param name="Z">Z coordinates (height)</param>
78        /// <param name="outRadius">[Output] Radius if not null on entry</param>
79        /// <param name="outZ">[Output] Z if not null on entry</param>
80        /// <returns>Angles; radius and Z are returned as output parameters, if on entry not null</returns>
81        /// <remarks>Theta, radius and Z must be the same size or either one may be scalar.
82        /// Polar coordinate arrays returned are of the same size then the input arrays.</remarks>
83        public static ILRetArray<float> cart2pol(ILInArray<float> X, ILInArray<float> Y, ILInArray<float> Z
84                                        ,ILOutArray<float> outRadius, ILOutArray<float> outZ) {
85            using (ILScope.Enter(X,Y,Z)) {   
86                if (!object.Equals(outRadius, null))
87                    outRadius.a = sqrt(X * X + Y * Y);
88                if (!object.Equals(outZ,null))
89                    outZ.a = Z.C;
90                return atan2(Y,X);
91            }
92        }
93    }
94}
Note: See TracBrowser for help on using the repository browser.