Skip to content

Commit ef135ab

Browse files
committed
cleanup readme
1 parent f5219b3 commit ef135ab

File tree

1 file changed

+7
-33
lines changed

1 file changed

+7
-33
lines changed

README.md

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -160,40 +160,7 @@ The labels of LArray and SLArray can be accessed
160160
by function `symbols`, which returns a tuple of symbols.
161161

162162

163-
## Labelled slices
164163

165-
For a labelled array where the row and column slices are labeled, use `@SLSlice`
166-
and `@LSlice`, similar to `@SLArray` and `@LArray` but passing a _tuple_ of label
167-
tuples.
168-
169-
For static arrays with labeled rows and columns:
170-
171-
```
172-
ABC = @SLSliced (3,2) (:a,:b,:c), (:x, :y)
173-
A = ABC([1 2; 3 4; 5 6])
174-
A.a.x == 1
175-
A[:c, :y] == 6
176-
```
177-
178-
For regular arrays with labeled rows and columns:
179-
180-
```
181-
A = @LSliced [1 2; 3 4; 5 6] (:a,:b,:c), (:x, :y)
182-
A.a.x == 1
183-
A[:c, :y] == 6
184-
```
185-
186-
The labels of LSliced and SLScliced can be accessed
187-
by function `symbols`.
188-
For a two-dimensional LSliced or SLSliced, it returns a tuple
189-
with first entry a tuple of row symbols and second entry a tuple of column symbols.
190-
For higher-dimensional slices, it returns a Tuple-Type object with
191-
parameters referring to the names of the dimensions.
192-
193-
```
194-
A = @LSliced [1 2; 3 4; 5 6] (:a,:b,:c), (:x, :y)
195-
symbols(A)[1] == (:a, :b, :c)
196-
```
197164

198165
## Example: Nice DiffEq Syntax Without A DSL
199166

@@ -289,3 +256,10 @@ As a result `SLArray` has less element type information, which
289256
improves compilation speed while giving more vector functionality
290257
than a NamedTuple. `LArray` also only has a single element type and,
291258
unlike a named tuple, is mutable.
259+
260+
261+
## Note: Labelled slices
262+
263+
This functionality has been removed from LabelledArrays.jl, but can
264+
replicated with the same compile-time performance and indexing syntax
265+
using [DimensionalData.jl](https://github.com/rafaqz/DimensionalData.jl).

0 commit comments

Comments
 (0)