Skip to content

Commit c8eac78

Browse files
committed
update docs
1 parent 3d608ee commit c8eac78

File tree

3 files changed

+36
-23
lines changed

3 files changed

+36
-23
lines changed

source/mir/interpolation/package.d

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,6 @@ struct Interp1(Range, Interpolation)
7676

7777
/++
7878
PCHIP interpolation.
79-
80-
Complexity:
81-
`O(x.length + xs.length)`
82-
83-
See_also:
84-
$(MREF mir,_interpolation,pchip)
8579
+/
8680
unittest
8781
{

source/mir/ndslice/slice.d

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,23 @@ enum SliceKind
8181
contiguous,
8282
}
8383

84-
/// Alias for $(LREF .SliceKind.universal).
84+
/++
85+
Alias for $(LREF .SliceKind.universal).
86+
87+
See_also:
88+
Internal Binary Representation section in $(LREF Slice).
8589
alias Universal = SliceKind.universal;
86-
/// Alias for $(LREF .SliceKind.canonical).
90+
/++
91+
Alias for $(LREF .SliceKind.canonical).
92+
93+
See_also:
94+
Internal Binary Representation section in $(LREF Slice).
8795
alias Canonical = SliceKind.canonical;
88-
/// Alias for $(LREF .SliceKind.contiguous).
96+
/++
97+
Alias for $(LREF .SliceKind.contiguous).
98+
99+
See_also:
100+
Internal Binary Representation section in $(LREF Slice).
89101
alias Contiguous = SliceKind.contiguous;
90102
91103
/// Extracts $(LREF SliceKind).
@@ -386,7 +398,7 @@ In the following table you will find the definitions you might come across
386398
in comments on operator overloading.
387399
388400
$(BOOKTABLE
389-
$(TR $(TH Definition) $(TH Examples at `N == 3`))
401+
$(TR $(TH Operator Overloading) $(TH Examples at `N == 3`))
390402
$(TR $(TD An $(B interval) is a part of a sequence of type `i .. j`.)
391403
$(STD `2..$-3`, `0..4`))
392404
$(TR $(TD An $(B index) is a part of a sequence of type `i`.)
@@ -407,13 +419,16 @@ $(TR $(TD An $(B indexed slice) is syntax sugar for $(SUBREF topology, indexed)
407419
408420
$(H3 Internal Binary Representation)
409421
410-
Multidimensional Slice is a structure that consists of lengths, strides, and a pointer.
411-
For ranges, a shell is used instead of a pointer.
412-
This shell contains a shift of the current initial element of a multidimensional slice
413-
and the range itself. With the exception of overloaded operators, no functions in this
414-
package change or copy data. The operations are only carried out on lengths, strides,
422+
Multidimensional Slice is a structure that consists of lengths, strides, and a iterator (pointer).
423+
424+
$(SUBREF topology, FieldIterator) shell is used to wrap fields and random access ranges.
425+
FieldIterator contains a shift of the current initial element of a multidimensional slice
426+
and the field itself.
427+
428+
With the exception of $(MREF mir,ndslice,allocation) module, no functions in this
429+
package move or copy data. The operations are only carried out on lengths, strides,
415430
and pointers. If a slice is defined over a range, only the shift of the initial element
416-
changes instead of the pointer.
431+
changes instead of the range.
417432
418433
$(H4 Internal Representation for Universal Slices)
419434
@@ -432,7 +447,7 @@ Slice!(Universal, [N], Iterator)
432447
Iterator _iterator
433448
-------
434449
435-
Example:
450+
$(H5 Example)
436451
437452
Definitions
438453

source/mir/timeseries.d

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,11 @@ struct Series(TimeIterator, SliceKind kind, size_t[] packs, Iterator)
108108
@fastmath:
109109

110110
/++
111-
Special `[] = ` index-assign operator for time-series.
112-
Assigns data from `r` for time intersection.
113-
This and `r` series are assumed to be sorted.
111+
Special `[] =` index-assign operator for time-series.
112+
Assigns data from `r` with time intersection.
113+
If a time index in `r` is not in the time index for this series, then no op-assign will take place.
114+
This and r series are assumed to be sorted.
115+
114116
Params:
115117
r = rvalue time-series
116118
+/
@@ -136,9 +138,11 @@ struct Series(TimeIterator, SliceKind kind, size_t[] packs, Iterator)
136138
}
137139

138140
/++
139-
Special `[] op= ` index-op-assign operator for time-series.
140-
Op-assigns data from `r` for time intersection.
141-
This and `r` series are assumed to be sorted.
141+
Special `[] op=` index-op-assign operator for time-series.
142+
Op-assigns data from `r` with time intersection.
143+
If a time index in `r` is not in the time index for this series, then no op-assign will take place.
144+
This and r series are assumed to be sorted.
145+
142146
Params:
143147
r = rvalue time-series
144148
+/

0 commit comments

Comments
 (0)