xtensor icon indicating copy to clipboard operation
xtensor copied to clipboard

Output of example in ReadMe file is not matching with the current master

Open faze-geek opened this issue 1 year ago • 2 comments

Kindly checkout the Index Access example from https://github.com/xtensor-stack/xtensor?tab=readme-ov-file#basic-usage .

#include <iostream>
#include "xtensor/xarray.hpp"
#include "xtensor/xio.hpp"

int main(){
    xt::xarray<double> arr1
    {{1.0, 2.0, 3.0},
    {2.0, 5.0, 7.0},
    {2.0, 5.0, 7.0}};

    std::cout << arr1(0, 0) << std::endl;
}

Output

anurag@Anurags-MacBook-Air numpy % g++ -std=c++17 -o numpy src/numpy.cpp -Iinclude
anurag@Anurags-MacBook-Air numpy % ./numpy                                        
1           // wrong

1.0 is expected which is correctly shown in the ReadMe output.

I have also run the example on binder jupyter notebook to avoid any discrepancy caused locally.

faze-geek avatar May 30 '24 03:05 faze-geek

I suspect this is a rounding issue in std::cout if you use the following line it displays correctly:

   std::cout << std::fixed << std::setprecision(1) << arr1(0, 0);

This is not an xtensor issue. 1 or 1.0 are equal and that is the correct output.

spectre-ns avatar Jul 06 '24 00:07 spectre-ns

I was not questioning the output, but with xtensor handling multiple dtypes getting 1. on print would be ideal. Let's make sure that the example prints in the same way as well to avoid any confusions.

It's a small refactor, maybe I can send in my first PR ?

  1. Update std::coutto use setprecision.
  2. Use a floating point number which won't be truncated like 1.5 instead of 1.0.
  3. Use xt::view(arr, 0, 0) for the indexing instead of arr(0, 0). This prints 1. as expected.

faze-geek avatar Jul 06 '24 03:07 faze-geek