Skip to content

Commit 807aa88

Browse files
committed
Some spelling corrections
1 parent 5b4122b commit 807aa88

29 files changed

Lines changed: 65 additions & 65 deletions

docs/source/changelog.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -575,7 +575,7 @@ Other changes
575575
`#1908 <https://github.com/xtensor-stack/xtensor/pull/1908>`_
576576
- Added ``noexcept`` in ``svector``
577577
`#1919 <https://github.com/xtensor-stack/xtensor/pull/1919>`_
578-
- Add implementation of repeat (similar to numpy)
578+
- Add implementation of repeat (similar to NumPy)
579579
`#1896 <https://github.com/xtensor-stack/xtensor/pull/1896>`_
580580
- Fix initialization of out shape in ``xt::tile``
581581
`#1923 <https://github.com/xtensor-stack/xtensor/pull/1923>`_
@@ -768,7 +768,7 @@ Other changes
768768
`#1676 <https://github.com/xtensor-stack/xtensor/pull/1676>`_
769769
- Added missing coma
770770
`#1680 <https://github.com/xtensor-stack/xtensor/pull/1680>`_
771-
- Added Numpy-like parameter in ``load_csv``
771+
- Added NumPy-like parameter in ``load_csv``
772772
`#1682 <https://github.com/xtensor-stack/xtensor/pull/1682>`_
773773
- Added ``shape()`` method to ``xshape.hpp``
774774
`#1592 <https://github.com/xtensor-stack/xtensor/pull/1592>`_
@@ -1421,17 +1421,17 @@ Other changes
14211421
`#1109 <https://github.com/xtensor-stack/xtensor/pull/1109>`_.
14221422
- Added test case for ``setdiff1d``
14231423
`#1110 <https://github.com/xtensor-stack/xtensor/pull/1110>`_.
1424-
- Added missing reference to ``diff`` in ``From numpy to xtensor`` section
1424+
- Added missing reference to ``diff`` in ``From NumPy to xtensor`` section
14251425
`#1116 <https://github.com/xtensor-stack/xtensor/pull/1116>`_.
14261426
- Add ``amax`` and ``amin`` to the documentation
14271427
`#1121 <https://github.com/xtensor-stack/xtensor/pull/1121>`_.
14281428
- ``histogram`` and ``histogram_bin_edges`` implementation
14291429
`#1108 <https://github.com/xtensor-stack/xtensor/pull/1108>`_.
1430-
- Added numpy comparison for interp
1430+
- Added NumPy comparison for interp
14311431
`#1111 <https://github.com/xtensor-stack/xtensor/pull/1111>`_.
14321432
- Allow multiple return type reducer functions
14331433
`#1113 <https://github.com/xtensor-stack/xtensor/pull/1113>`_.
1434-
- Fixes ``average`` bug + adds Numpy based tests
1434+
- Fixes ``average`` bug + adds NumPy based tests
14351435
`#1118 <https://github.com/xtensor-stack/xtensor/pull/1118>`_.
14361436
- Static ``xfunction`` cache for fixed sizes
14371437
`#1105 <https://github.com/xtensor-stack/xtensor/pull/1105>`_.
@@ -2122,7 +2122,7 @@ Breaking changes
21222122

21232123
- The API for ``xbuffer_adaptor`` has changed. The template parameter is the type of the buffer, not just the value type
21242124
`#482 <https://github.com/xtensor-stack/xtensor/pull/482>`_.
2125-
- Change ``edge_items`` print option to ``edgeitems`` for better numpy consistency
2125+
- Change ``edge_items`` print option to ``edgeitems`` for better NumPy consistency
21262126
`#489 <https://github.com/xtensor-stack/xtensor/pull/489>`_.
21272127
- *xtensor* now depends on *xtl* version `~0.3.3`
21282128
`#508 <https://github.com/xtensor-stack/xtensor/pull/508>`_.
@@ -2159,7 +2159,7 @@ Other changes
21592159
`#492 <https://github.com/xtensor-stack/xtensor/pull/492>`_.
21602160
- The ``size()`` method for containers now returns the total number of elements instead of the buffer size, which may differ when the smallest stride is greater than ``1``
21612161
`#502 <https://github.com/xtensor-stack/xtensor/pull/502>`_.
2162-
- The behavior of ``linspace`` with integral types has been made consistent with numpy
2162+
- The behavior of ``linspace`` with integral types has been made consistent with NumPy
21632163
`#510 <https://github.com/xtensor-stack/xtensor/pull/510>`_.
21642164

21652165
0.12.1

docs/source/closure-semantics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
Closure semantics
1010
=================
1111

12-
The *xtensor* library is a tensor expression library implementing numpy-style broadcasting and universal functions but in a lazy fashion.
12+
The *xtensor* library is a tensor expression library implementing NumPy-style broadcasting and universal functions but in a lazy fashion.
1313

1414
If ``x`` and ``y`` are two tensor expressions with compatible shapes, the result of ``x + y`` is not a tensor but an expression that does
1515
not hold any value. Values of ``x + y`` are computed upon access or when the result is assigned to a container such as :cpp:type:`xt::xtensor` or

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def setup(app):
4141
'goatcounter.js'
4242
]
4343

44-
# Automatically link to numpy doc
44+
# Automatically link to NumPy doc
4545
extensions += ['sphinx.ext.intersphinx']
4646
intersphinx_mapping = {
4747
"numpy": ("https://numpy.org/doc/stable/", None),

docs/source/container.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Runtime vs Compile-time dimensionality
7979
Three container classes implementing multidimensional arrays are provided: :cpp:type:`xt::xarray` and
8080
:cpp:type:`xt::xtensor` and :cpp:type:`xt::xtensor_fixed`.
8181

82-
- :cpp:type:`xt::xarray` can be reshaped dynamically to any number of dimensions. It is the container that is the most similar to numpy arrays.
82+
- :cpp:type:`xt::xarray` can be reshaped dynamically to any number of dimensions. It is the container that is the most similar to NumPy arrays.
8383
- :cpp:type:`xt::xtensor` has a dimension set at compilation time, which enables many optimizations.
8484
For example, shapes and strides of :cpp:type:`xt::xtensor` instances are allocated on the stack instead of the heap.
8585
- :cpp:type:`xt::xtensor_fixed` has a shape fixed at compile time.

docs/source/developer/concepts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,8 @@ If you read the entire code of ``xcontainer``, you'll notice that two types are
270270
strides and backstrides: ``shape_type`` and ``inner_shape_type``, ``strides_type`` and
271271
``inner_strides_type``, and ``backstrides_type`` and ``inner_backstrides_type``. The distinction
272272
between ``inner_shape_type`` and ``shape_type`` was motivated by the xtensor-python wrapper around
273-
numpy data structures, where the inner shape type is a proxy on the shape section of the numpy
274-
arrayobject. It cannot have a value semantics on its own as it is bound to the entire numpy array.
273+
NumPy data structures, where the inner shape type is a proxy on the shape section of the NumPy
274+
arrayobject. It cannot have a value semantics on its own as it is bound to the entire NumPy array.
275275

276276
``xstrided_container`` inherits from ``xcontainer``; it represents a container that holds its shape
277277
and strides. It provides methods for reshaping the container:

docs/source/expression.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Broadcasting
9090

9191
The number of dimensions of an :cpp:type:`xt::xexpression` and the sizes of these dimensions are provided by the :cpp:func:`~xt::xexpression::shape` method, which returns a sequence of unsigned integers
9292
specifying the size of each dimension. We can operate on expressions of different shapes of dimensions in an elementwise fashion.
93-
Broadcasting rules of *xtensor* are similar to those of Numpy_ and libdynd_.
93+
Broadcasting rules of *xtensor* are similar to those of NumPy_ and libdynd_.
9494

9595
In an operation involving two arrays of different dimensions, the array with the lesser dimensions is broadcast across the leading dimensions of the other.
9696
For example, if ``A`` has shape ``(2, 3)``, and ``B`` has shape ``(4, 2, 3)``, the result of a broadcast operation with ``A`` and ``B`` has shape ``(4, 2, 3)``.

docs/source/file_loading.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ format.
1313
Please note that many more input and output formats are available in the `xtensor-io
1414
<https://github.com/xtensor-stack/xtensor-io>`_ package.
1515
`xtensor-io` offers functions to load and store from image files (``jpg``, ``gif``, ``png``...),
16-
sound files (``wav``, ``ogg``...), HDF5 files (``h5``, ``hdf5``, ...), and compressed numpy format (``npz``).
16+
sound files (``wav``, ``ogg``...), HDF5 files (``h5``, ``hdf5``, ...), and compressed NumPy format (``npz``).
1717

1818

1919
Loading CSV data into xtensor

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Containers of *xtensor* are inspired by `NumPy`_, the Python array programming
2525
library. **Adaptors** for existing data structures to be plugged into the
2626
expression system can easily be written.
2727

28-
In fact, *xtensor* can be used to **process numpy data structures in-place**
29-
using Python's `buffer protocol`_. For more details on the numpy bindings,
28+
In fact, *xtensor* can be used to **process NumPy data structures in-place**
29+
using Python's `buffer protocol`_. For more details on the NumPy bindings,
3030
check out the xtensor-python_ project. Language bindings for R and Julia are
3131
also available.
3232

docs/source/numpy-differences.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ xtensor and numpy are very different libraries in their internal semantics. Whil
1515
is a lazy expression system, numpy manipulates in-memory containers, however, similarities in
1616
APIs are obvious. See e.g. the numpy to xtensor cheat sheet.
1717

18-
And this page tracks the subtle differences of behavior between numpy and xtensor.
18+
And this page tracks the subtle differences of behavior between NumPy and xtensor.
1919

2020
Zero-dimensional arrays
2121
-----------------------
2222

23-
With numpy, 0-D arrays are nearly indistinguishable from scalars. This led to some issues w.r.t.
23+
With NumPy, 0-D arrays are nearly indistinguishable from scalars. This led to some issues w.r.t.
2424
universal functions returning scalars with 0-D array inputs instead of actual arrays...
2525

2626
In xtensor, 0-D expressions are not implicitly convertible to scalar values. Values held by 0-D
@@ -87,15 +87,15 @@ be assigned to a container such as xarray or xtensor.
8787
Missing values
8888
--------------
8989

90-
Support of missing values in numpy can be emulated with the masked array module,
90+
Support of missing values in NumPy can be emulated with the masked array module,
9191
which provides a means to handle arrays that have missing or invalid data.
9292

9393
Support of missing values in xtensor is done through a notion of optional values, implemented in ``xoptional<T, B>``, which serves both as a value type for container and as a reference proxy for optimized storage types. See the section of the documentation on :doc:`missing`.
9494

9595
Strides
9696
-------
9797

98-
Strided containers of xtensor and numpy having the same exact memory layout may have different strides when accessing them through the ``strides`` attribute.
98+
Strided containers of xtensor and NumPy having the same exact memory layout may have different strides when accessing them through the ``strides`` attribute.
9999
The reason is an optimization in xtensor, which is to set the strides to ``0`` in dimensions of length ``1``, which simplifies the implementation of broadcasting of universal functions.
100100

101101
.. tip::
@@ -109,7 +109,7 @@ The reason is an optimization in xtensor, which is to set the strides to ``0`` i
109109
110110
xt::strides(a, xt::stride_type::internal); // ``== a.strides()``
111111
112-
xt::strides(a, xt::stride_type::bytes) // strides in bytes, as in numpy
112+
xt::strides(a, xt::stride_type::bytes) // strides in bytes, as in NumPy
113113
114114
115115
Array indices

docs/source/related.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ xtensor-python
2525

2626
The xtensor-python_ project provides the implementation of container types
2727
compatible with *xtensor*'s expression system, ``pyarray`` and ``pytensor``
28-
which effectively wrap numpy arrays, allowing operating on numpy arrays
28+
which effectively wrap NumPy arrays, allowing operating on NumPy arrays
2929
in-place.
3030

31-
Example 1: Use an algorithm of the C++ library on a numpy array in-place
31+
Example 1: Use an algorithm of the C++ library on a NumPy array in-place
3232
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3333

3434
**C++ code**
@@ -38,8 +38,8 @@ Example 1: Use an algorithm of the C++ library on a numpy array in-place
3838
#include <numeric> // Standard library import for std::accumulate
3939
#include <pybind11/pybind11.h> // Pybind11 import to define Python bindings
4040
#include <xtensor/xmath.hpp> // xtensor import for the C++ universal functions
41-
#define FORCE_IMPORT_ARRAY // numpy C api loading
42-
#include <xtensor-python/pyarray.hpp> // Numpy bindings
41+
#define FORCE_IMPORT_ARRAY // NumPy C api loading
42+
#include <xtensor-python/pyarray.hpp> // NumPy bindings
4343
4444
double sum_of_sines(xt::pyarray<double> &m)
4545
{
@@ -144,7 +144,7 @@ It takes care of the initial work of generating a project skeleton with
144144
A few examples included in the resulting project including
145145

146146
- A universal function defined from C++
147-
- A function making use of an algorithm from the STL on a numpy array
147+
- A function making use of an algorithm from the STL on a NumPy array
148148
- Unit tests
149149
- The generation of the HTML documentation with sphinx
150150

@@ -200,7 +200,7 @@ Example 1: Use an algorithm of the C++ library with a Julia array
200200
201201
1.2853996391883833
202202
203-
Example 2: Create a numpy-style universal function from a C++ scalar function
203+
Example 2: Create a NumPy-style universal function from a C++ scalar function
204204
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
205205

206206
**C++ code**
@@ -257,8 +257,8 @@ It takes care of the initial work of generating a project skeleton with
257257

258258
A few examples included in the resulting project including
259259

260-
- A numpy-style universal function defined from C++
261-
- A function making use of an algorithm from the STL on a numpy array
260+
- A NumPy-style universal function defined from C++
261+
- A function making use of an algorithm from the STL on a NumPy array
262262
- Unit tests
263263
- The generation of the HTML documentation with sphinx
264264

@@ -318,7 +318,7 @@ xtensor-blas
318318
The xtensor-blas_ project is an extension to the xtensor library, offering
319319
bindings to BLAS and LAPACK libraries through cxxblas and cxxlapack from the
320320
FLENS project. ``xtensor-blas`` powers the ``xt::linalg`` functionalities,
321-
which are the counterpart to numpy's ``linalg`` module.
321+
which are the counterpart to NumPy's ``linalg`` module.
322322

323323
xtensor-fftw
324324
------------
@@ -328,7 +328,7 @@ xtensor-fftw
328328

329329
The xtensor-fftw_ project is an extension to the xtensor library, offering
330330
bindings to the fftw library. ``xtensor-fftw`` powers the ``xt::fftw``
331-
functionalities, which are the counterpart to numpy's ``fft`` module.
331+
functionalities, which are the counterpart to NumPy's ``fft`` module.
332332

333333
Example 1: Calculate a derivative in Fourier space
334334
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)