|
565 | 565 | # U22: ==== LOG2 (x)
|
566 | 566 | _log2_docstring_ = """
|
567 | 567 | log2(x, out=None, order='K')
|
568 |
| -Computes the base 2 logarithm element-wise. |
| 568 | +
|
| 569 | +Computes the base-2 logarithm for each element `x_i` of input array `x`. |
| 570 | +
|
569 | 571 | Args:
|
570 | 572 | x (usm_ndarray):
|
571 | 573 | Input array, expected to have numeric data type.
|
572 |
| - out (usm_ndarray): |
573 |
| - Output array to populate. Array must have the correct |
574 |
| - shape and the expected data type. |
575 |
| - order ("C","F","A","K", optional): memory layout of the new |
576 |
| - output array, if parameter `out` is `None`. |
| 574 | + out ({None, usm_ndarray}, optional): |
| 575 | + Output array to populate. |
| 576 | + Array have the correct shape and the expected data type. |
| 577 | + order ("C","F","A","K", optional): |
| 578 | + Memory layout of the newly output array, if parameter `out` is `None`. |
577 | 579 | Default: "K".
|
578 |
| -Return: |
579 |
| - usm_ndarray: |
580 |
| - An array containing the element-wise base 2 logarithm values. |
| 580 | +Returns: |
| 581 | + usm_narray: |
| 582 | + An array containing the base-2 logarithm of `x`. |
| 583 | + The data type of the returned array is determined by the |
| 584 | + Type Promotion Rules. |
581 | 585 | """
|
582 | 586 |
|
583 | 587 | log2 = UnaryElementwiseFunc(
|
|
587 | 591 | # U23: ==== LOG10 (x)
|
588 | 592 | _log10_docstring_ = """
|
589 | 593 | log10(x, out=None, order='K')
|
590 |
| -Computes the base 10 logarithm element-wise. |
| 594 | +
|
| 595 | +Computes the base-10 logarithm for each element `x_i` of input array `x`. |
| 596 | +
|
591 | 597 | Args:
|
592 | 598 | x (usm_ndarray):
|
593 | 599 | Input array, expected to have numeric data type.
|
594 |
| - out (usm_ndarray): |
595 |
| - Output array to populate. Array must have the correct |
596 |
| - shape and the expected data type. |
597 |
| - order ("C","F","A","K", optional): memory layout of the new |
598 |
| - output array, if parameter `out` is `None`. |
| 600 | + out ({None, usm_ndarray}, optional): |
| 601 | + Output array to populate. |
| 602 | + Array have the correct shape and the expected data type. |
| 603 | + order ("C","F","A","K", optional): |
| 604 | + Memory layout of the newly output array, if parameter `out` is `None`. |
599 | 605 | Default: "K".
|
600 |
| -Return: |
601 |
| - usm_ndarray: |
602 |
| - An array containing the element-wise base 10 logarithm values. |
| 606 | +Returns: |
| 607 | + usm_narray: |
| 608 | + An array containing the base-1- logarithm of `x`. |
| 609 | + The data type of the returned array is determined by the |
| 610 | + Type Promotion Rules. |
603 | 611 | """
|
604 | 612 |
|
605 | 613 | log10 = UnaryElementwiseFunc(
|
|
0 commit comments