Skip to content

Commit a2e84ab

Browse files
ThisIsFineTMThisIsFineTM
committed
Update docs to reflect new directory structure.
1 parent a1b150f commit a2e84ab

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

+13-13
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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

‎docs/source/api/operators.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Operators and related functions
88
===============================
99

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

1212
.. doxygenfunction:: operator+(E&&)
1313

‎docs/source/api/power_functions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Power functions
1010

1111
**xtensor** provides the following power functions for xexpressions and scalars:
1212

13-
Defined in ``xtensor/xmath.hpp``
13+
Defined in ``xtensor/core/xmath.hpp``
1414

1515
.. doxygenfunction:: pow(E1&&, E2&&)
1616

‎docs/source/api/reducing_functions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Reducing functions
99

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

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

1414
.. doxygenfunction:: sum(E&&, EVS)
1515

@@ -49,7 +49,7 @@ Defined in ``xtensor/xmath.hpp``
4949

5050
.. doxygenfunction:: trapz(const xexpression<T>&, const xexpression<E>&, std::ptrdiff_t)
5151

52-
Defined in ``xtensor/xnorm.hpp``
52+
Defined in ``xtensor/reducers/xnorm.hpp``
5353

5454
.. doxygenfunction:: norm_l0(E&&, X&&, EVS)
5555

‎docs/source/api/trigonometric_functions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Trigonometric functions
99

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

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

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

‎docs/source/api/xaccumulator.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xaccumulator
88
============
99

10-
Defined in ``xtensor/xaccumulator.hpp``
10+
Defined in ``xtensor/reducers/xaccumulator.hpp``
1111

1212
.. doxygenfunction:: xt::accumulate(F&&, E&&, EVS)
1313

‎docs/source/api/xadapt.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xadapt
88
======
99

10-
Defined in ``xtensor/xadapt.hpp``
10+
Defined in ``xtensor/containers/xadapt.hpp``
1111

1212
.. cpp:namespace-push:: xt
1313

‎docs/source/api/xarray.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xarray
88
======
99

10-
Defined in ``xtensor/xarray.hpp``
10+
Defined in ``xtensor/containers/xarray.hpp``
1111

1212
.. doxygenclass:: xt::xarray_container
1313
:members:

‎docs/source/api/xarray_adaptor.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xarray_adaptor
88
==============
99

10-
Defined in ``xtensor/xarray.hpp``
10+
Defined in ``xtensor/containers/xarray.hpp``
1111

1212
.. doxygenclass:: xt::xarray_adaptor
1313
:members:

‎docs/source/api/xaxis_iterator.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xaxis_iterator
88
==============
99

10-
Defined in ``xtensor/xaxis_iterator.hpp``
10+
Defined in ``xtensor/views/xaxis_iterator.hpp``
1111

1212
.. doxygenclass:: xt::xaxis_iterator
1313
:members:

‎docs/source/api/xaxis_slice_iterator.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
xaxis_slice_iterator
99
====================
1010

11-
Defined in ``xtensor/xaxis_slice_iterator.hpp``
11+
Defined in ``xtensor/views/xaxis_slice_iterator.hpp``
1212

1313
.. doxygenclass:: xt::xaxis_slice_iterator
1414
:members:

‎docs/source/api/xbroadcast.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xbroadcast
88
==========
99

10-
Defined in ``xtensor/xbroadcast.hpp``
10+
Defined in ``xtensor/views/xbroadcast.hpp``
1111

1212
.. doxygenclass:: xt::xbroadcast
1313
:members:

‎docs/source/api/xbuilder.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xbuilder
88
========
99

10-
Defined in ``xtensor/xbuilder.hpp``
10+
Defined in ``xtensor/generators/xbuilder.hpp``
1111

1212
.. doxygenfunction:: xt::ones(S)
1313

‎docs/source/api/xcontainer.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
layout
88
======
99

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

1212
.. doxygenenum:: xt::layout_type
1313

@@ -16,15 +16,15 @@ Defined in ``xtensor/xlayout.hpp``
1616
xcontainer
1717
==========
1818

19-
Defined in ``xtensor/xcontainer.hpp``
19+
Defined in ``xtensor/containers/xcontainer.hpp``
2020

2121
.. doxygenclass:: xt::xcontainer
2222
:members:
2323

2424
xstrided_container
2525
==================
2626

27-
Defined in ``xtensor/xcontainer.hpp``
27+
Defined in ``xtensor/containers/xcontainer.hpp``
2828

2929
.. doxygenclass:: xt::xstrided_container
3030
:members:

‎docs/source/api/xcontainer_semantic.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xcontainer_semantic
88
===================
99

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

1212
.. doxygenclass:: xt::xcontainer_semantic
1313
:members:

‎docs/source/api/xcsv.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xcsv: read/write CSV files
88
==========================
99

10-
Defined in ``xtensor/xcsv.hpp``
10+
Defined in ``xtensor/io/xcsv.hpp``
1111

1212
.. doxygenfunction:: xt::load_csv
1313

‎docs/source/api/xexpression.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xexpression
88
===========
99

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

1212
.. doxygenclass:: xt::xexpression
1313
:members:

‎docs/source/api/xfixed.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xtensor_fixed
88
=============
99

10-
Defined in ``xtensor/xfixed.hpp``
10+
Defined in ``xtensor/containers/xfixed.hpp``
1111

1212
.. doxygenclass:: xt::xfixed_container
1313
:members:

‎docs/source/api/xfunction.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
xfunction
88
=========
99

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

1212
.. doxygenclass:: xt::xfunction
1313
:members:
1414

15-
Defined in ``xtensor/xmath.hpp``
15+
Defined in ``xtensor/core/xmath.hpp``
1616

1717
.. doxygenfunction:: make_lambda_xfunction

‎docs/source/api/xgenerator.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xgenerator
88
==========
99

10-
Defined in ``xtensor/xgenerator.hpp``
10+
Defined in ``xtensor/generators/xgenerator.hpp``
1111

1212
.. doxygenclass:: xt::xgenerator
1313
:members:

‎docs/source/api/xhistogram.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xhistogram
88
==========
99

10-
Defined in ``xtensor/xhistogram.hpp``
10+
Defined in ``xtensor/misc/xhistogram.hpp``
1111

1212
.. doxygenenum:: xt::histogram_algorithm
1313

‎docs/source/api/xindex_view.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
xindex_view
88
===========
99

10-
Defined in ``xtensor/xindex_view.hpp``
10+
Defined in ``xtensor/views/xindex_view.hpp``
1111

1212
.. doxygenclass:: xt::xindex_view
1313
:members:

‎docs/source/api/xio.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
xio: pretty printing
88
====================
99

10-
Defined in ``xtensor/xio.hpp``
10+
Defined in ``xtensor/io/xio.hpp``
1111

1212
This file defines functions for pretty printing xexpressions. It defines appropriate
1313
overloads for the ``<<`` operator for std::ostreams and xexpressions.
1414

1515
.. code::
1616
17-
#include <xtensor/xio.hpp>
18-
#include <xtensor/xarray.hpp>
17+
#include <xtensor/io/xio.hpp>
18+
#include <xtensor/containers/xarray.hpp>
1919
2020
int main()
2121
{

0 commit comments

Comments
 (0)