110401(DTXMania089)/SlimDXc_Jun2010(VC++2008)/source/math/Rational.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 #include "../design/RationalConverter.h"\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         /// <summary>\r
  29         /// Defines a rational number as a numerator / denominator pair.\r
  30         /// </summary>\r
  31         [System::Serializable]\r
  32         [System::Runtime::InteropServices::StructLayout( System::Runtime::InteropServices::LayoutKind::Sequential )]\r
  33         [System::ComponentModel::TypeConverter( SlimDX::Design::RationalConverter::typeid )]\r
  34         public value class Rational : System::IEquatable<Rational>\r
  35         {\r
  36         public:\r
  37                 /// <summary>\r
  38                 /// Gets or sets the numerator of the rational pair.\r
  39                 /// </summary>\r
  40                 int Numerator;\r
  41 \r
  42                 /// <summary>\r
  43                 /// Gets or sets the denominator of the rational pair.\r
  44                 /// </summary>\r
  45                 int Denominator;\r
  46                 \r
  47                 /// <summary>\r
  48                 /// Initializes a new instance of the <see cref="Rational"/> structure.\r
  49                 /// </summary>\r
  50                 /// <param name="numerator">The numerator of the rational pair.</param>\r
  51                 /// <param name="denominator">The denominator of the rational pair.</param>\r
  52                 Rational( int numerator, int denominator );\r
  53 \r
  54         virtual System::String^ ToString() override;\r
  55 \r
  56                 /// <summary>\r
  57                 /// Tests for equality between two objects.\r
  58                 /// </summary>\r
  59                 /// <param name="left">The first value to compare.</param>\r
  60                 /// <param name="right">The second value to compare.</param>\r
  61                 /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  62                 static bool operator == ( Rational left, Rational right );\r
  63 \r
  64                 /// <summary>\r
  65                 /// Tests for inequality between two objects.\r
  66                 /// </summary>\r
  67                 /// <param name="left">The first value to compare.</param>\r
  68                 /// <param name="right">The second value to compare.</param>\r
  69                 /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>\r
  70                 static bool operator != ( Rational left, Rational right );\r
  71 \r
  72                 /// <summary>\r
  73                 /// Returns the hash code for this instance.\r
  74                 /// </summary>\r
  75                 /// <returns>A 32-bit signed integer hash code.</returns>\r
  76                 virtual int GetHashCode() override;\r
  77 \r
  78                 /// <summary>\r
  79                 /// Returns a value that indicates whether the current instance is equal to a specified object. \r
  80                 /// </summary>\r
  81                 /// <param name="obj">Object to make the comparison with.</param>\r
  82                 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  83                 virtual bool Equals( System::Object^ obj ) override;\r
  84 \r
  85                 /// <summary>\r
  86                 /// Returns a value that indicates whether the current instance is equal to the specified object. \r
  87                 /// </summary>\r
  88                 /// <param name="other">Object to make the comparison with.</param>\r
  89                 /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>\r
  90                 virtual bool Equals( Rational other );\r
  91 \r
  92                 /// <summary>\r
  93                 /// Determines whether the specified object instances are considered equal. \r
  94                 /// </summary>\r
  95                 /// <param name="value1"></param>\r
  96                 /// <param name="value2"></param>\r
  97                 /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or \r
  98                 /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>\r
  99                 static bool Equals( Rational% value1, Rational% value2 );\r
 100         };\r
 101 };