@@ -504,13 +504,27 @@ pub struct ArrayBase<S, D>
504
504
/// An array where the data has shared ownership and is copy on write.
505
505
/// It can act as both an owner as the data as well as a shared reference (view
506
506
/// like).
507
+ ///
508
+ /// The `RcArray<A, D>` is parameterized by `A` for the element type and `D` for
509
+ /// the dimensionality.
510
+ ///
511
+ /// [**`ArrayBase`**](struct.ArrayBase.html) is used to implement both the owned
512
+ /// arrays and the views; see its docs for an overview of all array features.
513
+ ///
514
+ /// See also:
515
+ ///
516
+ /// + [Constructor Methods for Owned Arrays](struct.ArrayBase.html#constructor-methods-for-owned-arrays)
517
+ /// + [Methods For All Array Types](struct.ArrayBase.html#methods-for-all-array-types)
507
518
pub type RcArray < A , D > = ArrayBase < OwnedRcRepr < A > , D > ;
508
519
509
520
/// An array that owns its data uniquely.
510
521
///
511
522
/// `Array` is the main n-dimensional array type, and it owns all its array
512
523
/// elements.
513
524
///
525
+ /// The `Array<A, D>` is parameterized by `A` for the element type and `D` for
526
+ /// the dimensionality.
527
+ ///
514
528
/// [**`ArrayBase`**](struct.ArrayBase.html) is used to implement both the owned
515
529
/// arrays and the views; see its docs for an overview of all array features.
516
530
///
@@ -521,25 +535,34 @@ pub type RcArray<A, D> = ArrayBase<OwnedRcRepr<A>, D>;
521
535
/// + Dimensionality-specific type alises
522
536
/// [`Array1`](Array1.t.html),
523
537
/// [`Array2`](Array2.t.html),
524
- /// [`Array3`](Array3.t.html) and so on.
538
+ /// [`Array3`](Array3.t.html), ...,
539
+ /// [`ArrayD`](ArrayD.t.html),
540
+ /// and so on.
525
541
pub type Array < A , D > = ArrayBase < OwnedRepr < A > , D > ;
526
542
527
- /// A lightweight array view.
543
+ /// A read-only array view.
528
544
///
529
545
/// An array view represents an array or a part of it, created from
530
546
/// an iterator, subview or slice of an array.
531
547
///
548
+ /// The `ArrayView<'a, A, D>` is parameterized by `'a` for the scope of the
549
+ /// borrow, `A` for the element type and `D` for the dimensionality.
550
+ ///
532
551
/// Array views have all the methods of an array (see [`ArrayBase`][ab]).
533
552
///
534
553
/// See also [**Methods Specific To Array Views**](struct.ArrayBase.html#methods-specific-to-array-views)
535
554
///
536
555
/// [ab]: struct.ArrayBase.html
537
556
pub type ArrayView < ' a , A , D > = ArrayBase < ViewRepr < & ' a A > , D > ;
538
- /// A lightweight read-write array view.
557
+
558
+ /// A read-write array view.
539
559
///
540
560
/// An array view represents an array or a part of it, created from
541
561
/// an iterator, subview or slice of an array.
542
562
///
563
+ /// The `ArrayViewMut<'a, A, D>` is parameterized by `'a` for the scope of the
564
+ /// borrow, `A` for the element type and `D` for the dimensionality.
565
+ ///
543
566
/// Array views have all the methods of an array (see [`ArrayBase`][ab]).
544
567
///
545
568
/// See also [**Methods Specific To Array Views**](struct.ArrayBase.html#methods-specific-to-array-views)
0 commit comments