Skip to content

Commit cd07eaa

Browse files
authored
Update docs to reflect new directory structure. (#2845)
1 parent a1b150f commit cd07eaa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+251
-251
lines changed

docs/source/adaptor.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ The following example shows how to bring an ``std::vector`` into the expression
2020
2121
#include <cstddef>
2222
#include <vector>
23-
#include <xtensor/xarray.hpp>
24-
#include <xtensor/xadapt.hpp>
23+
#include <xtensor/containers/xarray.hpp>
24+
#include <xtensor/containers/xadapt.hpp>
2525
2626
std::vector<double> v = {1., 2., 3., 4., 5., 6. };
2727
std::vector<std::size_t> shape = { 2, 3 };
@@ -50,7 +50,7 @@ ownership of the array:
5050
.. code::
5151
5252
#include <cstddef>
53-
#include <xtensor/xadapt.hpp>
53+
#include <xtensor/containers/xadapt.hpp>
5454
5555
void compute(double* data, std::size_t size)
5656
{
@@ -82,8 +82,8 @@ the ownership of the array, meaning it will be deleted when the adaptor is destr
8282
.. code::
8383
8484
#include <cstddef>
85-
#include <xtensor/xarray.hpp>
86-
#include <xtensor/xadapt.hpp>
85+
#include <xtensor/containers/xarray.hpp>
86+
#include <xtensor/containers/xadapt.hpp>
8787
8888
void compute(double*& data, std::size_t size)
8989
{
@@ -119,8 +119,8 @@ adaptor before calling ``compute`` and pass it to the function:
119119
.. code::
120120
121121
#include <cstddef>
122-
#include <xtensor/xarray.hpp>
123-
#include <xtensor/xadapt.hpp>
122+
#include <xtensor/containers/xarray.hpp>
123+
#include <xtensor/containers/xadapt.hpp>
124124
125125
template <class A>
126126
void compute(A& a)
@@ -154,8 +154,8 @@ Adapting C arrays allocated on the stack is as simple as adapting ``std::vector`
154154
155155
#include <cstddef>
156156
#include <vector>
157-
#include <xtensor/xarray.hpp>
158-
#include <xtensor/xadapt.hpp>
157+
#include <xtensor/containers/xarray.hpp>
158+
#include <xtensor/containers/xadapt.hpp>
159159
160160
double v[6] = {1., 2., 3., 4., 5., 6. };
161161
std::vector<std::size_t> shape = { 2, 3 };
@@ -185,8 +185,8 @@ It will automatically increment the reference count of shared pointers upon crea
185185
.. code::
186186
187187
#include <memory>
188-
#include <xtensor/xadapt.hpp>
189-
#include <xtensor/xio.hpp>
188+
#include <xtensor/containers/xadapt.hpp>
189+
#include <xtensor/io/xio.hpp>
190190
191191
std::shared_ptr<double> sptr(new double[8], std::default_delete<double[]>());
192192
sptr.get()[2] = 321.;
@@ -201,8 +201,8 @@ memory) as follows:
201201
.. code::
202202
203203
#include <memory>
204-
#include <xtensor/xadapt.hpp>
205-
#include <xtensor/xio.hpp>
204+
#include <xtensor/containers/xadapt.hpp>
205+
#include <xtensor/io/xio.hpp>
206206
207207
struct Buffer {
208208
Buffer(std::vector<double>& buf) : m_buf(buf) {}

docs/source/api/accumulating_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Accumulating functions
99

1010
**xtensor** provides the following accumulating functions for xexpressions:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: cumsum(E&&)
1515

docs/source/api/basic_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Basic functions
99

1010
**xtensor** provides the following basic functions for xexpressions and scalars:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: abs(E&&)
1515

docs/source/api/classif_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Classification functions
99

1010
**xtensor** provides the following classification functions for xexpressions and scalars:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: isfinite(E&&)
1515

docs/source/api/error_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Error and gamma functions
99

1010
**xtensor** provides the following error and gamma functions for xexpressions:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: erf(E&&)
1515

docs/source/api/exponential_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Exponential functions
99

1010
**xtensor** provides the following exponential functions for xexpressions:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: exp(E&&)
1515

docs/source/api/hyperbolic_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Hyperbolic functions
99

1010
**xtensor** provides the following hyperbolic functions for xexpressions:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. _sinh-function-reference:
1515
.. doxygenfunction:: sinh(E&&)

docs/source/api/index_related.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Index related functions
88
=======================
99

10-
Defined in ``xtensor/xoperation.hpp``
10+
Defined in ``xtensor/core/xoperation.hpp``
1111

1212
.. doxygenfunction:: where(const T&)
1313

docs/source/api/nan_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ NaN functions
99

1010
**xtensor** provides the following functions that deal with NaNs in xexpressions:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: nan_to_num(E&&)
1515

docs/source/api/nearint_operations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Nearest integer floating point operations
99

1010
**xtensor** provides the following rounding operations for xexpressions:
1111

12-
Defined in ``xtensor/xmath.hpp``
12+
Defined in ``xtensor/core/xmath.hpp``
1313

1414
.. doxygenfunction:: ceil(E&&)
1515

0 commit comments

Comments
 (0)