More docs

svn path=/trunk/mcs/; revision=117707

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16b.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16b.xml
index 3994f271b8658221f0305d42bd0ec885953a664a..5e97f8811a042a7e51f873e8aa12d3c713d9de7c 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16b.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16b.xml
@@ -72,11 +72,18 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">The first vector.</param>
+        <param name="vb">The second vector.</param>
+        <summary>Adds two vectors with saturation.</summary>
+        <returns>The saturated addition of two vectors.</returns>
+        <remarks>
+         <para>
+           The resulting vector contains the saturated sum of the individual components of the vector.
+         </para>
+         <para>
+           If the sum of two of the components would overflow, then the result of the saturated sum is Byte.MaxValue.
+         </para>
+       </remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -98,11 +105,14 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
+        <summary>Averages the component values in the vectors.</summary>
+        <returns>A new vector with the averaged results.</returns>
+        <remarks>Performs an average computations of the values in the
+        two vectors.  The operation is performed in hardware by adding
+        the two numbers, adding one to the temporary result and then
+        shifting the result one bit to the right.</remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -124,8 +134,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>Compares the elements of two vectors for equality.</summary>
         <returns>A new vector with the comparison results.</returns>
         <remarks>Equal components get the Byte.MaxValue, unequal components get the zero value.</remarks>
@@ -149,10 +159,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -225,8 +235,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -251,8 +261,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -277,8 +287,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -303,8 +313,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -329,8 +339,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -355,8 +365,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -609,8 +619,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -688,8 +698,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -722,8 +732,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -743,8 +753,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -769,8 +779,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16b" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16sb.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16sb.xml
index aae3bbbdca80f303bf487a989a7f3fd58ad75712..28733af08ae0d639361a6d3d2d57bf2e24e5a08a 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16sb.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector16sb.xml
@@ -82,11 +82,16 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <summary>Adds two vectors with saturation.</summary>
+        <returns>The saturated addition of two vectors.</returns>
+        <remarks>
+         <para>
+           The resulting vector contains the saturated sum of the individual components of the vector.
+         </para>
+         <para>
+           If the sum of two of the components would overflow, then the result of the saturated sum is either SByte.MinValue (underflow) or SByte.MaxValue (overflow).
+         </para>
+       </remarks>
       </Docs>
     </Member>
     <Member MemberName="CompareEqual">
@@ -108,8 +113,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>Compares the elements of two vectors for equality.</summary>
         <returns>A new vector with the comparison results.</returns>
         <remarks>Equal components are set to -1, unequal components get the zero value.</remarks>
@@ -134,8 +139,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -159,10 +164,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
     </Member>
     <Member MemberName="LoadAligned">
@@ -232,8 +237,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -258,8 +263,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -284,8 +289,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -310,8 +315,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -336,8 +341,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -362,8 +367,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -604,8 +609,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -680,8 +685,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -706,8 +711,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -732,8 +737,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector16sb" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2l.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2l.xml
index 1a187e85b666757a40bc9a1c0835e0dd7c25662f..23b8687c55146dbdf371f1429c61b0a2e6332a3f 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2l.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2l.xml
@@ -100,10 +100,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector2l" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
     </Member>
     <Member MemberName="LoadAligned">

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2ul.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2ul.xml
index a5cc302596b7d25816986e7d69bb7150e5206638..ea85b6b882a84ecfcc32ad8d2952b143f35e8e93 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2ul.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector2ul.xml
@@ -79,10 +79,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector2ul" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
     </Member>
     <Member MemberName="LoadAligned">

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4i.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4i.xml
index 11f6e507a0bf0760938c8e5ff1d7a9cf455af36a..7fa40157eb2a494315eae1c8af921426e4626b0e 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4i.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4i.xml
@@ -106,10 +106,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector4i" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
     </Member>
     <Member MemberName="LoadAligned">
@@ -670,8 +670,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector4i" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -699,8 +699,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector4i" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4ui.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4ui.xml
index cdd8b787b5b4ebaa6deecc8de78f1bcb5079126a..10ccf5db0603a3ec90f9e96d853ce82ccd102a6c 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4ui.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector4ui.xml
@@ -80,10 +80,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector4ui" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -686,8 +686,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector4ui" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -712,8 +712,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector4ui" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8s.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8s.xml
index 7e08ee3b3527c7674ef829f4b2ea6ea20be7fd14..a1c783d8ac6cefa80d45b458249e9ef3437bd063 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8s.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8s.xml
@@ -61,11 +61,16 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <summary>Adds two vectors with saturation.</summary>
+        <returns>The saturated addition of two vectors.</returns>
+        <remarks>
+         <para>
+           The resulting vector contains the saturated sum of the individual components of the vector.
+         </para>
+         <para>
+           If the sum of two of the components would overflow, then the result of the saturated sum is either Int16.MinValue (underflow) or Int16.MaxValue (overflow).
+         </para>
+       </remarks>
       </Docs>
     </Member>
     <Member MemberName="CompareEqual">
@@ -87,8 +92,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>Compares the elements of two vectors for equality.</summary>
 
         <returns>A new vector with the comparison results.</returns>
@@ -115,8 +120,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -140,10 +145,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
     </Member>
     <Member MemberName="LoadAligned">
@@ -216,8 +221,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -242,8 +247,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -268,8 +273,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -294,8 +299,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -320,8 +325,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -346,8 +351,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -372,8 +377,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -626,7 +631,7 @@
         <Parameter Name="amount" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="amount">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -652,8 +657,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -678,7 +683,7 @@
         <Parameter Name="amount" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="amount">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -704,8 +709,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -733,8 +738,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -759,8 +764,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -785,7 +790,7 @@
         <Parameter Name="amount" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="amount">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -811,7 +816,7 @@
         <Parameter Name="sel" Type="Mono.Simd.ShuffleSel" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="sel">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -837,7 +842,7 @@
         <Parameter Name="sel" Type="Mono.Simd.ShuffleSel" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="sel">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -916,8 +921,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -942,8 +947,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -968,8 +973,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8s" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

diff --git a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8us.xml b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8us.xml
index 510475b9bae901588fc4dc7097795e06a65088c8..13d5aa79192d0f94c8f7099af86b2a8b98b5c2c6 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8us.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/Mono.Simd/Vector8us.xml
@@ -61,11 +61,16 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <summary>Adds two vectors with saturation.</summary>
+        <returns>The saturated addition of two vectors.</returns>
+        <remarks>
+         <para>
+           The resulting vector contains the saturated sum of the individual components of the vector.
+         </para>
+         <para>
+           If the sum of two of the components would overflow, then the result of the saturated sum is UInt16.MaxValue.
+         </para>
+       </remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -87,11 +92,14 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
+        <summary>Averages the component values in the vectors.</summary>
+        <returns>A new vector with the averaged results.</returns>
+        <remarks>Performs an average computations of the values in the
+        two vectors.  The operation is performed in hardware by adding
+        the two numbers, adding one to the temporary result and then
+        shifting the result one bit to the right.</remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -118,8 +126,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>Compares the elements of two vectors for equality.</summary>
 
         <returns>A new vector with the comparison results.</returns>
@@ -140,10 +148,10 @@
         <Parameter Name="va" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="va">Vector.</param>
+        <summary>Extracts a byte mask from the vector.</summary>
+        <returns>An integer with the low 16 bits representing the mask.</returns>
+        <remarks>This returns a 16-bit value where each bit is formed from the most significant bit of each byte.</remarks>
       </Docs>
       <Attributes>
         <Attribute>
@@ -213,8 +221,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -239,8 +247,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -270,8 +278,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -291,8 +299,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -317,8 +325,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -343,8 +351,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -369,8 +377,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -611,7 +619,7 @@
         <Parameter Name="amount" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="amount">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -637,8 +645,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -663,7 +671,7 @@
         <Parameter Name="amount" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="amount">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -689,8 +697,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -715,7 +723,7 @@
         <Parameter Name="amount" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="amount">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -741,7 +749,7 @@
         <Parameter Name="sel" Type="Mono.Simd.ShuffleSel" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="sel">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -767,7 +775,7 @@
         <Parameter Name="sel" Type="Mono.Simd.ShuffleSel" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
+        <param name="va">First vector.</param>
         <param name="sel">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
@@ -798,8 +806,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -824,8 +832,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -895,8 +903,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -921,8 +929,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -947,8 +955,8 @@
         <Parameter Name="vb" Type="Mono.Simd.Vector8us" />
       </Parameters>
       <Docs>
-        <param name="va">To be added.</param>
-        <param name="vb">To be added.</param>
+        <param name="va">First vector.</param>
+        <param name="vb">Second vector.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

diff --git a/mcs/class/Mono.Simd/Documentation/en/ns-Mono.Simd.xml b/mcs/class/Mono.Simd/Documentation/en/ns-Mono.Simd.xml
index 32c4a928e37f2a417f26e38de72cd066d5976a13..61adf05fabfb2f780ab8bcd32d607cedb3b7b6fa 100644 (file)
--- a/mcs/class/Mono.Simd/Documentation/en/ns-Mono.Simd.xml
+++ b/mcs/class/Mono.Simd/Documentation/en/ns-Mono.Simd.xml
@@ -41,6 +41,13 @@
          use this flag to determine if they want to use the operations
          implemented in software or not.
       </para>
+
+      <para>
+       Casting operations are also cheap, converting from one data
+       type to another have a very low cost.  This is useful to move
+       information back and forth from floating point values to
+       integers.
+      </para>
     </remarks>
   </Docs>
 </Namespace>