Microsoft.ML.CpuMath.xml 35.3 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.ML.CpuMath</name>
    </assembly>
    <members>
        <member name="T:Microsoft.ML.Internal.CpuMath.AlignedArray">
             <summary>
             This implements a logical array of floats that is automatically aligned for SSE/AVX operations.
             To pin and force alignment, call the GetPin method, typically wrapped in a using (since it
             returns a Pin struct that is IDisposable). From the pin, you can get the IntPtr to pass to
             native code.
            
             The ctor takes an alignment value, which must be a power of two at least sizeof(float).
             </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.AlignedArray.#ctor(System.Int32,System.Int32)">
            <summary>
            Allocate an aligned vector with the given alignment (in bytes).
            The alignment must be a power of two and at least sizeof(Float).
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.CpuAlignedVector">
            <summary>
            This implements a logical array of Floats that is automatically aligned for SSE/AVX operations.
            This is a thin wrapper around the AlignedArray type implemented in C++. This simply couples
            the AlignedArray with a logical size, which does not include padding, while the AlignedArray
            size does include padding.
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.ValueCount">
            <summary>
            The value count.
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.VectorSize">
            <summary>
            The logical size of the vector.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.#ctor(System.Int32,System.Int32)">
            <summary>
            Allocate an aligned vector with the given alignment (in bytes).
            The alignment must be a power of two and at least sizeof(Float).
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.Items">
            <summary>
            The physical AligenedArray items.
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.CbAlign">
            <summary>
            The alignment.
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.Item(System.Int32)">
            <summary>
            Set and get the value of the vector at the given index.
            </summary>
            <param name="index">The index</param>
            <returns>The value at the given index</returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.GetValue(System.Int32)">
            <summary>
            Get the value of the vector at the given index.
            </summary>
            <param name="i">The index</param>
            <returns>The value at the given index</returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.Randomize(System.Func{System.Single})">
            <summary>
            Assign randomized values to the vector elements via the input function.
            </summary>
            <param name="rand">The input rand om function that takes no arguments and returns a float value</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.Zero">
            <summary>
            Assign zeros to the vector elements.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.CopyTo(System.Single[],System.Int32@)">
            <summary>
            Copy the values into dst, starting at slot ivDst and advancing ivDst.
            </summary>
            <param name="dst">The destination array</param>
            <param name="ivDst">The starting index in the destination array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.CopyTo(System.Int32,System.Single[],System.Int32,System.Int32)">
            <summary>
            Copy the values from this vector starting at slot ivSrc into dst, starting at slot ivDst.
            The number of values that are copied is determined by count.
            </summary>
            <param name="ivSrc">The staring index in this vector</param>
            <param name="dst">The destination array</param>
            <param name="ivDst">The starting index in the destination array</param>
            <param name="count">The number of elements to be copied</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.CopyFrom(System.Single[],System.Int32@)">
            <summary>
            Copy the values from src, starting at slot index and advancing index, into this vector.
            </summary>
            <param name="src">The source array</param>
            <param name="index">The starting index in the source array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.CopyFrom(System.Int32,System.Single[],System.Int32,System.Int32)">
            <summary>
            Copy the values from src, starting at slot index and advancing index, into this vector, starting at slot ivDst.
            The number of values that are copied is determined by count.
            </summary>
            <param name="ivDst">The staring index in this vector</param>
            <param name="src">The source array</param>
            <param name="ivSrc">The starting index in the source array</param>
            <param name="count">The number of elements to be copied</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.CopyFrom(Microsoft.ML.Internal.CpuMath.CpuAlignedVector)">
            <summary>
            Copy the values of src vector into this vector. The src vector must have the same size as this vector.
            </summary>
            <param name="src">The source vector</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedVector.GetEnumerator">
            <summary>
            Get the underlying AlignedArray as IEnumerator&lt;Float&gt;.
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase">
            <summary>
            This implements a logical matrix of Floats that is automatically aligned for SSE/AVX operations.
            The ctor takes an alignment value, which must be a power of two at least sizeof(Float).
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.ValueCount">
            <summary>
            The logical number values in the matrix
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.RowCount">
            <summary>
            The logical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.ColCount">
            <summary>
            The logical number of columns
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.RowCountPhy">
            <summary>
            The physical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.ColCountPhy">
            <summary>
            The pysical number of columns
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.#ctor(System.Int32,System.Int32,System.Int32)">
            <summary>
            Allocate an aligned matrix with the given alignment (in bytes).
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.Randomize(System.Func{System.Single})">
            <summary>
            Assign randomized values to the matrix elements via the input function.
            </summary>
            <param name="rand">The input rand om function that takes no arguments and returns a float value</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.Zero">
            <summary>
            Assign zeros to the matrix elements.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase.CopyFrom(Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixBase)">
            <summary>
            Copy the values of src matrix into this matrix. The src matrix must have the same physical and logical size as this matrix.
            </summary>
            <param name="src">The source matrix</param>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase">
            <summary>
            This implements a logical row-major matrix of Floats that is automatically aligned for SSE/AVX operations.
            The ctor takes an alignment value, which must be a power of two at least sizeof(Float).
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.RowCount">
            <summary>
            The logical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.ColCount">
            <summary>
            The logical number of columns
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.RowCountPhy">
            <summary>
            The physical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.ColCountPhy">
            <summary>
            The physical number of columns
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.CopyTo(System.Single[],System.Int32@)">
            <summary>
            Copy the values into dst, starting at slot ivDst and advancing ivDst.
            </summary>
            <param name="dst">The destination array</param>
            <param name="ivDst">The starting index in the destination array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.CopyFrom(System.Single[],System.Int32@)">
            <summary>
            Copy the values from src, starting at slot ivSrc and advancing ivSrc.
            </summary>
            <param name="src">The source array</param>
            <param name="ivSrc">The starting index in the source array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRowBase.GetEnumerator">
            <summary>
            Get the underlying AlignedArray as IEnumerator&lt;Float&gt;.
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow">
            <summary>
            This implements a row-major matrix of Floats that is automatically aligned for SSE/AVX operations.
            The ctor takes an alignment value, which must be a power of two at least sizeof(Float).
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow.RowCount">
            <summary>
            The logical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow.ColCount">
            <summary>
            The logical number of columns
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow.RowCountPhy">
            <summary>
            The physical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow.ColCountPhy">
            <summary>
            The physical number of columns
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow.CopyTo(System.Int32,System.Single[],System.Int32@)">
            <summary>
            Copy the values from this matrix, starting from the row into dst, starting at slot ivDst and advancing ivDst.
            </summary>
            <param name="row">The starting row in this matrix</param>
            <param name="dst">The destination array</param>
            <param name="ivDst">The starting index in the destination array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixRow.ZeroItems(System.Int32[])">
            <summary>
            Assign zeros to the values at the indices
            </summary>
            <param name="indices">The indices</param>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol">
            <summary>
            This implements a logical matrix of Floats that is automatically aligned for SSE/AVX operations.
            The ctor takes an alignment value, which must be a power of two at least sizeof(Float).
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.#ctor(System.Int32,System.Int32,System.Int32)">
            <summary>
            Allocate an aligned matrix with the given alignment (in bytes).
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.RowCount">
            <summary>
            The logical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.ColCount">
            <summary>
            The logical number of columns
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.RowCountPhy">
            <summary>
            The physical number of rows
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.ColCountPhy">
            <summary>
            The physical number of columns
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.CopyTo(System.Single[],System.Int32@)">
            <summary>
            Copy the values into dst, starting at slot ivDst and advancing ivDst.
            </summary>
            <param name="dst">The destination array</param>
            <param name="ivDst">The starting index in the destination array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.CopyTo(System.Int32,System.Single[],System.Int32@)">
            <summary>
            Copy the values from this matrix, starting from the row into dst, starting at slot ivDst and advancing ivDst.
            </summary>
            <param name="row">The starting row in this matrix</param>
            <param name="dst">The destination array</param>
            <param name="ivDst">The starting index in the destination array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.CopyFrom(System.Single[],System.Int32@)">
            <summary>
            Copy the values from src, starting at slot ivSrc and advancing ivSrc.
            </summary>
            <param name="src">The source array</param>
            <param name="ivSrc">The starting index in the source array</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.ZeroItems(System.Int32[])">
            <summary>
            Assign zeros to the values at the indices
            </summary>
            <param name="indices">The indices</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAlignedMatrixCol.GetEnumerator">
            <summary>
            Get the underlying AlignedArray as IEnumerator&lt;Float&gt;.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAligenedMathUtils`1.AssertCompatible(Microsoft.ML.Internal.CpuMath.ICpuFullMatrix)">
            <summary>
            Assert the compatibility of the underlying AlignedArray for the input matrix in terms of alignment amount.
            </summary>
            <param name="values">The input matrix</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAligenedMathUtils`1.AssertCompatible(Microsoft.ML.Internal.CpuMath.ICpuVector)">
            <summary>
            Assert the compatibility of the underlying AlignedArray for the input vector in terms of alignment amount.
            </summary>
            <param name="values">The input vector</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAligenedMathUtils`1.AssertCompatible(Microsoft.ML.Internal.CpuMath.ICpuFullMatrix,Microsoft.ML.Internal.CpuMath.ICpuVector,Microsoft.ML.Internal.CpuMath.ICpuVector)">
            <summary>
            Asserts the following:
            1. The compatibility of the underlying AlignedArray for mat in terms of alignment amount.
            2. The compatibility of the underlying AlignedArray for src in terms of alignment amount.
            3. The compatibility of the underlying AlignedArray for dst in terms of alignment amount.
            4. The compatibility of the matrix-vector multiplication mat * src = dst.
            </summary>
            <param name="mat"></param>
            <param name="src"></param>
            <param name="dst"></param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAligenedMathUtils`1.MatTimesSrc(Microsoft.ML.Internal.CpuMath.ICpuFullMatrix,Microsoft.ML.Internal.CpuMath.ICpuVector,Microsoft.ML.Internal.CpuMath.ICpuVector)">
            <summary>
            Matrix multiplication:
            dst = mat * src
            </summary>
            <param name="mat">The multiplier matrix</param>
            <param name="src">The source vector</param>
            <param name="dst">The destination vector</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.CpuAligenedMathUtils`1.MatTranTimesSrc(Microsoft.ML.Internal.CpuMath.ICpuFullMatrix,Microsoft.ML.Internal.CpuMath.ICpuVector,Microsoft.ML.Internal.CpuMath.ICpuVector)">
            <summary>
            Matrix transpose multiplication:
            dst = mat' * src
            </summary>
            <param name="mat">The multiplier matrix</param>
            <param name="src">The source vector</param>
            <param name="dst">The destination vector</param>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.GeneralUtils.CbitLowZero(System.UInt32)">
            <summary>
            Count the number of zero bits in the lonest string of zero's from the lowest significant bit of the input integer.
            </summary>
            <param name="u">The input integer</param>
            <returns></returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuBuffer`1.Randomize(System.Func{`0})">
            <summary>
            Assign random values using the given random function.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuBuffer`1.Zero">
            <summary>
            Set all values to zero.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuBuffer`1.CopyTo(`0[],System.Int32@)">
            <summary>
            Copy the values into dst, starting at slot ivDst and advancing ivDst.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuBuffer`1.CopyFrom(`0[],System.Int32@)">
            <summary>
            Copy values from the given src array into this buffer, starting at the given index in src,
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.ICpuVector">
            <summary>
            A logical math vector.
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.ICpuVector.VectorSize">
            <summary>
            The vector size
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuVector.GetValue(System.Int32)">
            <summary>
            Get the i'th component of the vector.
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.ICpuMatrix.RowCount">
            <summary>
            The row count
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.ICpuMatrix.ColCount">
            <summary>
            the column count
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.ICpuFullMatrix">
            <summary>
            A 2-dimensional matrix.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuFullMatrix.CopyTo(System.Int32,System.Single[],System.Int32@)">
            <summary>
            Copy the values for the given row into dst, starting at slot ivDst.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ICpuFullMatrix.ZeroItems(System.Int32[])">
            <summary>
            Zero out the items with the given indices.
            The indices contain the logical indices to the vectorized representation of the matrix,
            which can be different depending on whether the matrix is row-major or column-major.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.Add(System.UInt64@,System.UInt64@,System.UInt64)">
            <summary>
            Add src to the 128 bits contained in dst. Ignores overflow, that is, the addition is done modulo 2^128.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.Add(System.UInt64@,System.UInt64@,System.UInt64,System.UInt64)">
            <summary>
            Add src to dst. Ignores overflow, that is, the addition is done modulo 2^128.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.Sub(System.UInt64@,System.UInt64@,System.UInt64)">
            <summary>
            Subtract src from the 128 bits contained in dst. Ignores overflow, that is, the subtraction is
            done modulo 2^128.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.Sub(System.UInt64@,System.UInt64@,System.UInt64,System.UInt64)">
            <summary>
            Subtract src from dst. Ignores overflow, that is, the subtraction is done modulo 2^128.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.LessThan(System.UInt64,System.UInt64,System.UInt64,System.UInt64)">
            <summary>
            Return true if a is less than b.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.Div64(System.UInt64,System.UInt64,System.UInt64,System.UInt64@)">
            <summary>
            Divide the 128 bit value in <paramref name="lo"/> and <paramref name="hi"/> by <paramref name="den"/>.
            returning the quotient and placing the remainder in <paramref name="rem"/>. Throws on overflow.
            Note that <paramref name="lo"/> comes before <paramref name="hi"/>.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.Mul64(System.UInt64,System.UInt64,System.UInt64@)">
            <summary>
            Multiple the two 64-bit values to produce 128 bit result.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.DivRound(System.UInt64,System.UInt64,System.UInt64)">
            <summary>
            Divide and round to nearest using unbiased rounding. Throws on overflow.
            Note that <paramref name="lo"/> comes before <paramref name="hi"/>.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.DivRound(System.UInt64,System.UInt64,System.UInt64,System.UInt64)">
            <summary>
            Divide and round to nearest using unbiased rounding. Throws on overflow.
            Note that <paramref name="numLo"/> comes before <paramref name="numHi"/>.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.CbitHighZero(System.UInt64)">
            <summary>
            Return the number of zero bits on the high end.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.MulDiv64Core(System.UInt64,System.UInt64,System.UInt64,System.UInt64@)">
            <summary>
            Multiply <paramref name="a"/> and <paramref name="b"/> and divide by <paramref name="den"/>,
            returning the quotient and placing the remainder in <paramref name="rem"/>. Throws on overflow.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.IntUtils.TryMulDiv64Core(System.UInt64,System.UInt64,System.UInt64,System.UInt64@,System.UInt64@)">
            <summary>
            Multiply <paramref name="a"/> and <paramref name="b"/> and divide by <paramref name="den"/>,
            placing the quotient in <paramref name="quo"/> and the remainder in <paramref name="rem"/>.
            Returns true on success. On overflow, places zero in the out parameters and returns false.
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.ProbabilityFunctions">
            <summary>
            Probability Functions.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ProbabilityFunctions.Erfc(System.Double)">
            <summary>
            The approximate complimentary error function (i.e., 1-erf).
            </summary>
            <param name="x">The input parameter, of infinite range.</param>
            <returns>Evaluation of the function</returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ProbabilityFunctions.Erf(System.Double)">
            <summary>
            The approximate error function.
            </summary>
            <param name="x">The input parameter, of infinite range.</param>
            <returns>Evaluation of the function</returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ProbabilityFunctions.Erfinv(System.Double)">
            <summary>
            The inverse error function.
            </summary>
            <param name="x">Parameter in the range 1 to -1.</param>
            <returns>Evaluation of the function.</returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.ProbabilityFunctions.Probit(System.Double)">
            <summary>
            The probit function. This has many applications, the most familiar being perhaps
            that this is the point "x" at which the standard normal CDF evaluates to the indicated
            p value. It is used in establishing confidence intervals.
            </summary>
            <param name="p">The input p value, so in the range 0 to 1.</param>
            <returns>One intepretation is, the value at which the standard normal CDF evaluates to p.</returns>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.Core.IExceptionContext">
            <summary>
            Interface for "processing" exceptions before they are thrown. This can
            be used to add context to the exception, wrap the exception in another one,
            totally replace the exception, etc. It is not legal to return null from
            Process (unless null was passed in, which really shouldn't happen).
            </summary>
        </member>
        <member name="P:Microsoft.ML.Internal.CpuMath.Core.IExceptionContext.ContextDescription">
            <summary>
            A string describing the context itself.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.Process``1(``0,Microsoft.ML.Internal.CpuMath.Core.IExceptionContext)">
            <summary>
            Does standard processing of an exception (typically called after construction
            but before it is thrown).
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.Mark``1(``0)">
            <summary>
            Mark the exception by setting <see cref="F:Microsoft.ML.Internal.CpuMath.Core.Contracts.IsMarkedKey"/> in the exception
            <see cref="P:System.Exception.Data"/> to 1.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.IsMarked(System.Exception)">
            <summary>
            Indicates whether the exception was "marked" the Contracts code.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.MarkSensitive``1(``0,Microsoft.ML.Internal.CpuMath.Core.MessageSensitivity)">
            <summary>
            Exceptions whose message communicates potentially sensitive information should be
            marked using this method, before they are thrown. Note that if the exception already
            had this flag set, the message will be flagged with the bitwise or of the existing
            flag, alongside the passed in sensivity.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.Sensitivity(System.Exception)">
            <summary>
            This is a convenience method to get the sensitivity of an exception,
            as encoded with <see cref="F:Microsoft.ML.Internal.CpuMath.Core.Contracts.SensitivityKey"/>. If there is no key, then
            the message is assumed to be of unknown sensitivity, i.e., it is assumed
            that it might contain literally anything.
            </summary>
            <param name="ex">The exception to query</param>
            <returns>The value encoded at the <see cref="F:Microsoft.ML.Internal.CpuMath.Core.Contracts.SensitivityKey"/>, if it is
            a <see cref="T:Microsoft.ML.Internal.CpuMath.Core.MessageSensitivity"/> value. If neither of these conditions
            hold then <see cref="F:Microsoft.ML.Internal.CpuMath.Core.MessageSensitivity.Unknown"/> is returned.</returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.SetAssertHandler(System.Action{System.String,Microsoft.ML.Internal.CpuMath.Core.IExceptionContext})">
            <summary>
            Sets the assert handler to the given function, returning the previous handler.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.Except">
            <summary>
            Default exception type (currently InvalidOperationException)
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptUserArg(System.String)">
            <summary>
            For signalling bad user input.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptParam(System.String)">
            <summary>
            For signalling bad function parameters.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptValue(System.String)">
            <summary>
            For signalling null function parameters.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptEmpty(System.String)">
            <summary>
            For signalling null or empty function parameters (strings, arrays, collections, etc).
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptWhiteSpace(System.String)">
            <summary>
            For signalling null, empty or white-space function parameters (strings, arrays, collections, etc).
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptDecode">
            <summary>
            For signalling errors in decoding information, whether while reading from a file,
            parsing user input, etc.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptIO">
            <summary>
            For signalling IO failures.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptNotImpl">
            <summary>
            For signalling functionality that is not YET implemented.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptNotSupp">
            <summary>
            For signalling functionality that is not implemented by design.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.ExceptSchemaMismatch(System.String,System.String,System.String)">
            <summary>
            For signalling schema validation issues.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.CheckUserArg(System.Boolean,System.String)">
            <summary>
            CheckUserArg / ExceptUserArg should be used when the validation of user-provided arguments failed.
            Typically, this is shortly after the arguments are parsed using CmdParser.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.CheckValueOrNull``1(``0)">
            <summary>
            This documents that the parameter can legally be null.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.CheckValueOrNull``1(Microsoft.ML.Internal.CpuMath.Core.IExceptionContext,``0)">
            <summary>
            This documents that the parameter can legally be null.
            </summary>
        </member>
        <member name="M:Microsoft.ML.Internal.CpuMath.Core.Contracts.AssertValueOrNull``1(``0)">
            <summary>
            This documents that the parameter can legally be null.
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.Core.BestFriendAttribute">
            <summary>
            Intended to be applied to types and members with internal scope to indicate that friend access of this
            internal item is OK from another assembly. This restriction applies only to assemblies that declare the
            <see cref="T:Microsoft.ML.Internal.CpuMath.Core.WantsToBeBestFriendsAttribute"/> assembly level attribute. Note that this attribute is not
            transferrable: an internal member with this attribute does not somehow make a containing internal type
            accessible. Conversely, neither does marking an internal type make any unmarked internal members accessible.
            </summary>
        </member>
        <member name="T:Microsoft.ML.Internal.CpuMath.Core.WantsToBeBestFriendsAttribute">
            <summary>
            This is an assembly level attribute to signal that friend accesses on this assembly should be checked
            for usage of <see cref="T:Microsoft.ML.Internal.CpuMath.Core.BestFriendAttribute"/>. If this attribute is missing, normal access rules for
            friends should apply.
            </summary>
        </member>
    </members>
</doc>