File size: 40,398 Bytes
68ce2fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  Author(s):  Daniel Li, Ofri Sadowsky, Anton Deguet
  Created on: 2006-07-10

  (C) Copyright 2006-2018 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#pragma once
#ifndef _vctDynamicNArrayBase_h
#define _vctDynamicNArrayBase_h

/*!
  \file
  \brief Declaration of vctDynamicNArrayBase
*/

#include <cisstVector/vctDynamicConstNArrayBase.h>
#include <cisstVector/vctStoreBackUnaryOperations.h>
#include <cisstVector/vctStoreBackBinaryOperations.h>

/*!
  This class provides all the const methods inherited from
  vctDynamicConstNArrayBase, and extends them with non const methods, such
  as SumOf.

  \sa vctDynamicConstNArrayBase
*/
template<class _nArrayOwnerType, typename _elementType, vct::size_type _dimension>
class vctDynamicNArrayBase: public vctDynamicConstNArrayBase<_nArrayOwnerType, _elementType, _dimension>
{
public:
    /* define most types from vctContainerTraits and vctNArrayTraits */
    VCT_CONTAINER_TRAITS_TYPEDEFS(_elementType);
    VCT_NARRAY_TRAITS_TYPEDEFS(_dimension);

    /*! Type of the nArray itself */
    typedef vctDynamicNArrayBase ThisType;

    /*! Type of the base class */
    typedef vctDynamicConstNArrayBase<_nArrayOwnerType, _elementType, _dimension> BaseType;

    /*! Type of the data owner (dynamic array or pointer) */
    typedef _nArrayOwnerType OwnerType;

    enum {DIMENSION = OwnerType::DIMENSION};

    /*! \name Iterators on the elements of the nArray */
    //@{
    typedef typename OwnerType::iterator iterator;
    typedef typename OwnerType::const_iterator const_iterator;
    typedef typename OwnerType::reverse_iterator reverse_iterator;
    typedef typename OwnerType::const_reverse_iterator const_reverse_iterator;
    //@}

    /*! \name The type of the object representing a subarray of
      this nArray. Access is by (const and non const) reference. */
    //@{
    typedef typename BaseType::ConstSubarrayRefType ConstSubarrayRefType;
    typedef typename BaseType::SubarrayRefType SubarrayRefType;
    //@}

    /*! \name The type of the object representing a permutation of
      this nArray. Access is by (const and non const) reference. */
    //@{
    typedef typename BaseType::ConstPermutationRefType ConstPermutationRefType;
    typedef typename BaseType::PermutationRefType PermutationRefType;
    //@}

    /*! \name The type of the object representing a slice of this
      nArray. Access is by (const and non const) reference. */
    //@{
    typedef typename BaseType::SlicesTypes SlicesTypes;
    typedef typename BaseType::ConstSliceRefType ConstSliceRefType;
    typedef typename BaseType::SliceRefType SliceRefType;
    //@}


    /*! Returns an iterator on the first element (STL
      compatibility). */
    iterator begin(void)
    {
        return this->NArray.begin();
    }

    /* documented in base class */
    const_iterator begin(void) const
    {
        return BaseType::begin();
    }

    /*! Returns an iterator on the last element (STL
      compatibility). */
    iterator end(void)
    {
        return this->NArray.end();
    }

    /* documented in base class */
    const_iterator end(void) const
    {
        return BaseType::end();
    }

    /*! Returns a reverse iterator on the last element (STL
      compatibility). */
    reverse_iterator rbegin(void)
    {
        return this->NArray.rbegin();
    }

    /* documented in base class */
    const_reverse_iterator rbegin(void) const
    {
        return BaseType::rbegin();
    }

    /*! Returns a reverse iterator on the element before first
      (STL compatibility). */
    reverse_iterator rend(void)
    {
        return this->NArray.rend();
    }

    /* documented in base class */
    const_reverse_iterator rend(void) const
    {
        return BaseType::rend();
    }


    /* documented in base class */
    const OwnerType & Owner(void) const {
        return BaseType::Owner();
    }
    OwnerType & Owner(void) {
        return this->NArray;
    }


    /*! Return a non const pointer to an element of the container,
      specified by its indices. Addition to the STL requirements.
    */
    pointer Pointer(const nsize_type & indices)
    {
        return this->NArray.Pointer(indices);
    }

    /* documented in base class */
    const_pointer Pointer(const nsize_type & indices) const
    {
        return BaseType::Pointer(indices);
    }

    /*! Returns a non const pointer to the first element of the
      container. Addition to the STL requirements.
    */
    pointer Pointer(void)
    {
        return this->NArray.Pointer();
    }

    /* documented in base class */
    const_pointer Pointer(void) const
    {
        return BaseType::Pointer();
    }


    /*! Access an element by index (non const).  Compare with std::vector::at().
      This method can be a handy substitute for the overloaded operator () when
      operator overloading is unavailable or inconvenient.
      \return a const reference to the element at indices */
    reference at(size_type metaIndex)
        CISST_THROW(std::out_of_range)
    {
        this->ThrowUnlessValidIndex(metaIndex);
        return (begin())[metaIndex];
    }


    /* documented in base class */
    const_reference at(size_type metaIndex) const
        CISST_THROW(std::out_of_range)
    {
        return BaseType::at(metaIndex);
    }


    /*! Access an element by index.  Compare with std::vector::at().
      This method can be a handy substitute for the overloaded operator () when
      operator overloading is unavailable or inconvenient.
      \return a reference to the element at indices */
    reference at(const nsize_type & coordinates)
        CISST_THROW(std::out_of_range)
    {
        this->ThrowUnlessValidIndex(coordinates);
        return *(Pointer(coordinates));
    }

    /* documented in base class */
    const_reference at(const nsize_type & coordinates) const
        CISST_THROW(std::out_of_range)
    {
        return BaseType::at(coordinates);
    }


    /*! Overloaded operator () for simplified (non const) element access with bounds checking */
    reference operator () (const nsize_type & coordinates)
        CISST_THROW(std::out_of_range)
    {
        return this->at(coordinates);
    }

    /*! documented in base class */
     const_reference operator () (const nsize_type & coordinates) const
        CISST_THROW(std::out_of_range)
    {
        return BaseType::operator()(coordinates);
    }


    /*! Access an element by indices (non const). This method allows
      to access an element without any bounds checking.  It doesn't
      create any temporary references as a nArray[][]...[] would do.

      \return a reference to the element at the specified indices */
    reference Element(const nsize_type & coordinates)
    {
        return *(Pointer(coordinates));
    }

    /* documented in base class */
    const_reference Element(const nsize_type & coordinates) const
    {
        return BaseType::Element(coordinates);
    }


    /*! Create a non-const reference to a subarray of this nArray.
        \param startPosition vector of indices of the element position where the reference will start
        \param lengths the number of elements to reference in each dimension

        \note Preserves the number of dimensions.
    */
    SubarrayRefType Subarray(const nsize_type & startPosition,
                             const nsize_type & lengths)
    {
        SubarrayRefType subarray;
        subarray.SubarrayOf(*this, startPosition, lengths);
        return subarray;
    }


    /*! documented in base class */
    ConstSubarrayRefType Subarray(const nsize_type & startPosition,
                                  const nsize_type & lengths) const
    {
        return BaseType::Subarray(startPosition, lengths);
    }


    /*! Create a non-const reference to this nArray with the strides permuted.
        \param dimensions a sequence of dimension numbers representing the
          permuted order of strides

        \note Preserves the number of dimensions.
    */
    PermutationRefType Permutation(const ndimension_type & dimensions)
    {
        PermutationRefType permutation;
        permutation.PermutationOf(*this, dimensions);
        return permutation;
    }


    /*! documented in base class */
    ConstPermutationRefType Permutation(const ndimension_type & dimensions) const
    {
        return BaseType::Permutation(dimensions);
    }


    /*! Create a non-const reference to a slice of dimension n-1, where n is the
          dimension of this nArray.
        \param dimension the dimension number of the direction by which to reduce
        \param slice the index number in the dimension specified by which to set
          the reference

        \note The number of dimensions is reduced by one.
    */
    SliceRefType Slice(dimension_type dimension, size_type index)
    {
        return SlicesTypes::SliceOf(*this, dimension, index);
    }


    /*! documented in base class */
    ConstSliceRefType Slice(dimension_type dimension, size_type index) const
    {
        return BaseType::Slice(dimension, index);
    }


    /*! Reference an (n-1)-dimension slice of this nArray by index (non-const).
        \return a non-const reference to the given index in the most
          significant dimension
    */
    SliceRefType operator[](size_type index)
    {
        return this->Slice(0, index);
    }


    /*! documented in base class */
    ConstSliceRefType operator[](size_type index) const
    {
        return BaseType::operator[](index);
    }


    /*! Assign the given value to all the elements.
      \param value the value used to set all the elements of the nArray
      \return The value used to set all the elements
    */
    inline value_type SetAll(const value_type value)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi<typename vctStoreBackBinaryOperations<value_type>::SecondOperand>::
            Run(*this, value);
        return value;
    }


    /*! Assign zero to all elements.  This methods assumes that the
      element type has a zero and this zero value can be set using
      memset(0).  If the nArray is not compact this method will use
      SetAll(0) and memset otherwise.  This provides a slightly more
      efficent way to set all elements to zero.

      \return true if the nArray is compact and memset was used, false
      otherwise. */
    inline bool Zeros(void) {
        if (this->IsCompact()) {
            memset(this->Pointer(), 0, this->size() * sizeof(value_type));
            return true;
        } else {
            this->SetAll(static_cast<value_type>(0));
            return false;
        }
    }

    /*!
      \name Assignment operation between arrays containing the same data type but different owners
      \param other The array to be copied.
    */
    //@{
    template <class __nArrayOwnerType>
    inline ThisType & Assign(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & other) {
        if (this->FastCopyCompatible(other)) {
            this->FastCopyOf(other, false);
        } else {
            vctDynamicNArrayLoopEngines<DIMENSION>::template
                NoNi<typename vctUnaryOperations<value_type,
                typename __nArrayOwnerType::value_type>::Identity>::
                Run(*this, other);
        }
        return *this;
    }
    //@}


    /*!
      \name Assignment operation between nArrays of different types.

      \param other The nArray to be copied.
    */
    //@{
    template <class __nArrayOwnerType, typename __elementType>
    inline ThisType & Assign(const vctDynamicConstNArrayBase<__nArrayOwnerType, __elementType, DIMENSION> & other)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNi<typename vctUnaryOperations<value_type,
            typename __nArrayOwnerType::value_type>::Identity>::
            Run(*this, other);
        return *this;
    }

    template <class __nArrayOwnerType, typename __elementType>
    inline ThisType & operator = (const vctDynamicConstNArrayBase<__nArrayOwnerType, __elementType, DIMENSION> & other)
    {
        return this->Assign(other);
    }
    //@}


    /*! Assign to this nArray values from a C array given as a
      pointer to value_type. The purpose of this method is to simplify
      the syntax by not necessitating the creation of an explicit nArray
      for the given array. However, we only provide this method for
      an array of value_type. For arrays of other types an nArray
      still needs to be declared.

      \param elements a pointer to a C array of elements to be assigned
        to this nArray

      \note This method assumes two things: (1) that the input array is
        _packed_, that is, that all the elements are stored in a
        contiguous memory block with no gaps; and (2) that the storage
        order of the input array matches the storage order of this
        nArray.

      \return a reference to this object.
    */
    inline ThisType & Assign(const value_type * elements)
    {
        nstride_type strides;
        typename nsize_type::const_reverse_iterator sizesIter = this->sizes().rbegin();
        typename nstride_type::reverse_iterator stridesIter = strides.rbegin();
        const typename nstride_type::const_reverse_iterator stridesEnd = strides.rend();
        size_type sizesIter_value;
        stride_type previous_stride;

        if (stridesIter != stridesEnd)
        {
            *stridesIter = 1;
            previous_stride = 1;
            ++stridesIter;
        }

        for (; stridesIter != stridesEnd;
             ++stridesIter, ++sizesIter)
        {
            sizesIter_value = (*sizesIter == 0) ? 1 : *sizesIter;
            *stridesIter = sizesIter_value * previous_stride;
            previous_stride = *stridesIter;
        }

        const vctDynamicConstNArrayRef<value_type, DIMENSION> tmpRef(elements,
                                                                      this->sizes(),
                                                                      strides);
        this->Assign(tmpRef);
        return *this;
    }


    /*!  Forced assignment operation between arrays of
      different types.  This method will use SetSize on the
      destination array (this nArray) to make sure the assignment
      will work.  It is important to note that if the sizes don't
      match, memory for this array will be re-allocated.  If the
      program has previously created some references (as in
      vctDynamic{Const}NArrayRef) on this array, they will become
      invalid.

      \note For a non-reallocating Assign, it is recommended to use
      the Assign() methods.

      \note If the destination array doesn't have the same size as
      the source and can not be resized, an exception will be thrown
      by the Assign method called internally.

      \param other The array to be copied.
    */
    template <class __nArrayOwnerType, typename __elementType>
    inline ThisType & ForceAssign(const vctDynamicConstNArrayBase<__nArrayOwnerType, __elementType, DIMENSION> & other) {
        return this->Assign(other);
    }


    /*! Fast copy.  This method uses <code>memcpy</code> whenever it
        is possible to perform a fast copy from another array to this
        array.

        - The method will first verify that the source and destination
          have the same sizes and throws an exception otherwise
          (<code>std::runtime_error</code>).  See ::cmnThrow for
          details.

        - If any of the two narray is not compact or if the two narray
          use a different layout (different strides), this method will
          return <code>false</code>.  If both narrays are compact and
          have the same strides, a <code>memcpy</code> is performed
          and the method returns <code>true</code>.

        - To avoid the tests above, one can set the parameter
          <code>performSafetyChecks</code> to <code>false</code>.
          This should be used only when the programmer knows for sure
          that the source and destination are compatible (sizes,
          strides and compactness).

        - As opposed to Assign, this method doesn't perform any type
          conversion.

        - Since no constructor is called for the contained elements,
          this function performs a "shallow copy".  If the contained
          objects have a pointer as data member, the copied object
          will carry on the same pointer (hence pointing at the same
          memory block which could easily lead to bugs).

        The basic and safe use of this method for an array would be:
        \code
        if (!destination.FastCopyOf(source)) {
            destination.Assign(source);
        }
        \endcode

        If the method is to be called many times (in a loop for
        example), it is recommended to check that the source and
        destination are compatible once and then use the option
        to turn off the different safety checks for each FastCopyOf.
        \code
        bool canUseFastCopy = destination.FastCopyPossible(source);
        vct::index_type index;
        for (index = 0; index < 1000; index++) {
            DoSomethingUseful(source);
            if (canUseFastCopy) {
                destination.FastCopyOf(source, false); // Do not check again
            } else {
                destination.Assign(source);
            }
        }
        \endcode

        \param source NArray used to set the content of this array.

        \param performSafetyChecks Flag set to <code>false</code> to
        avoid safety checks, use with extreme caution.
     */
    //@{
    template <class __nArrayOwnerType>
    inline bool FastCopyOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & source,
                           bool performSafetyChecks = true)
        CISST_THROW(std::runtime_error)
    {
        return vctFastCopy::NArrayCopy(*this, source, performSafetyChecks);
    }
    //@}


    /*! \name Binary elementwise operations between two nArrays.
      Store the result of op(nArray1, nArray2) to a third nArray. */
    //@{
    /*! Binary elementwise operations between two nArrays.  For each
      element of the nArrays, performs \f$ this[i] \leftarrow
      op(nArray1[i], nArray2[i])\f$ where \f$op\f$ is either an
      addition (SumOf), a subtraction (DifferenceOf), a multiplication
      (ElementwiseProductOf), a division (ElementwiseRatioOf), a
      minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

      \param nArray1 The first operand of the binary operation

      \param nArray2 The second operand of the binary operation

      \return The nArray "this" modified.
    */
    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & SumOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                            const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiNi< typename vctBinaryOperations<value_type>::Addition >
            ::Run(*this, nArray1, nArray2);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & DifferenceOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                                   const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiNi< typename vctBinaryOperations<value_type>::Subtraction >
            ::Run(*this, nArray1, nArray2);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & ElementwiseProductOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                                           const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiNi< typename vctBinaryOperations<value_type>::Multiplication >
            ::Run(*this, nArray1, nArray2);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & ElementwiseRatioOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                                         const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiNi< typename vctBinaryOperations<value_type>::Division >
            ::Run(*this, nArray1, nArray2);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & ElementwiseMinOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                                       const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiNi< typename vctBinaryOperations<value_type>::Minimum >
            ::Run(*this, nArray1, nArray2);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & ElementwiseMaxOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                                       const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiNi< typename vctBinaryOperations<value_type>::Maximum >
            ::Run(*this, nArray1, nArray2);
        return *this;
    }
    //@}



    /*! \name Binary elementwise operations between two nArrays.
      Store the result of op(this, otherNArray) back to this nArray. */
    //@{
    /*! Store back binary elementwise operations between two
      nArrays.  For each element of the nArrays, performs \f$
      this[i] \leftarrow op(this[i], otherNArray[i])\f$ where
      \f$op\f$ is either an addition (Add), a subtraction
      (Subtraction), a multiplication (ElementwiseMultiply) a division
      (ElementwiseDivide), a minimization (ElementwiseMin) or a
      maximisation (ElementwiseMax).

      \param otherNArray The second operand of the binary operation
      (this[i] is the first operand)

      \return The nArray "this" modified.
    */
    template <class __nArrayOwnerType>
    inline ThisType & Add(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNi<typename vctStoreBackBinaryOperations<value_type>::Addition >::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & Subtract(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNi< typename vctStoreBackBinaryOperations<value_type>::Subtraction >::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ElementwiseMultiply(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNi< typename vctStoreBackBinaryOperations<value_type>::Multiplication >::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ElementwiseDivide(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNi< typename vctStoreBackBinaryOperations<value_type>::Division >::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ElementwiseMin(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNi< typename vctStoreBackBinaryOperations<value_type>::Minimum >::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ElementwiseMax(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNi< typename vctStoreBackBinaryOperations<value_type>::Maximum >::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & operator += (const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        return this->Add(otherNArray);
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & operator -= (const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        return this->Subtract(otherNArray);
    }
    //@}


    /*! \name Binary elementwise operations an nArray and a scalar.
      Store the result of op(nArray, scalar) to a third nArray. */
    //@{
    /*! Binary elementwise operations between an nArray and a scalar.
      For each element of the nArray "this", performs \f$ this[i]
      \leftarrow op(nArray[i], scalar)\f$ where \f$op\f$ is either an
      addition (SumOf), a subtraction (DifferenceOf), a multiplication
      (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or
      a maximum (ClippedBelowOf).

      \param nArray The first operand of the binary operation.
      \param scalar The second operand of the binary operation.

      \return The nArray "this" modified.
    */
    template <class __nArrayOwnerType>
    inline ThisType & SumOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray,
                            const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiSi< typename vctBinaryOperations<value_type>::Addition >::
            Run(*this, nArray, scalar);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & DifferenceOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray,
                                   const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiSi< typename vctBinaryOperations<value_type>::Subtraction >::
            Run(*this, nArray, scalar);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ProductOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray,
                                const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiSi< typename vctBinaryOperations<value_type>::Multiplication >::
            Run(*this, nArray, scalar);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & RatioOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray,
                              const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiSi< typename vctBinaryOperations<value_type>::Division >::
            Run(*this, nArray, scalar);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ClippedAboveOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray,
                                     const value_type lowerBound)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiSi<typename vctBinaryOperations<value_type>::Minimum>::
            Run(*this, nArray, lowerBound);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ClippedBelowOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray,
                                     const value_type upperBound)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNiSi< typename vctBinaryOperations<value_type>::Maximum >::
            Run(*this, nArray, upperBound);
        return *this;
    }
    //@}



    /*! \name Binary elementwise operations a scalar and an nArray.
      Store the result of op(scalar, nArray) to a third nArray. */
    //@{
    /*! Binary elementwise operations between a scalar and an nArray.
      For each element of the nArray "this", performs \f$ this[i]
      \leftarrow op(scalar, nArray[i])\f$ where \f$op\f$ is either an
      addition (SumOf), a subtraction (DifferenceOf), a multiplication
      (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or
      a maximum (ClippedBelowOf).

      \param scalar The first operand of the binary operation.
      \param nArray The second operand of the binary operation.

      \return The nArray "this" modified.
    */
    template <class __nArrayOwnerType>
    inline ThisType & SumOf(const value_type scalar,
                            const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoSiNi< typename vctBinaryOperations<value_type>::Addition >::
            Run(*this, scalar, nArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & DifferenceOf(const value_type scalar,
                                   const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoSiNi< typename vctBinaryOperations<value_type>::Subtraction >::
            Run(*this, scalar, nArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ProductOf(const value_type scalar,
                                const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoSiNi< typename vctBinaryOperations<value_type>::Multiplication >::
            Run(*this, scalar, nArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & RatioOf(const value_type scalar,
                              const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoSiNi< typename vctBinaryOperations<value_type>::Division >::
            Run(*this, scalar, nArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ClippedAboveOf(const value_type upperBound,
                                     const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoSiNi< typename vctBinaryOperations<value_type>::Minimum >::
            Run(*this, upperBound, nArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & ClippedBelowOf(const value_type lowerBound,
                                     const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & nArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoSiNi< typename vctBinaryOperations<value_type>::Maximum >::
            Run(*this, lowerBound, nArray);
        return *this;
    }
    //@}


    /*! \name Binary elementwise operations between an nArray and a scalar.
      Store the result of op(this, scalar) back to this nArray. */
    //@{
    /*! Store back binary elementwise operations between an nArray and
      a scalar.  For each element of the nArray "this", performs \f$
      this[i] \leftarrow op(this[i], scalar)\f$ where \f$op\f$ is
      either an addition (Add), a subtraction (Subtract), a
      multiplication (Multiply), a division (Divide), a minimum
      (ClipAbove) or a maximum (ClipBelow).

      \param scalar The second operand of the binary operation
        (this[i] is the first operand).

      \return The nArray "this" modified.
    */
    inline ThisType & Add(const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi< typename vctStoreBackBinaryOperations<value_type>::Addition >::
            Run(*this, scalar);
        return *this;
    }

    /* documented above */
    inline ThisType & Subtract(const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi< typename vctStoreBackBinaryOperations<value_type>::Subtraction >::
            Run(*this, scalar);
        return *this;
    }

    /* documented above */
    inline ThisType & Multiply(const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi< typename vctStoreBackBinaryOperations<value_type>::Multiplication >::
            Run(*this, scalar);
        return *this;
    }

    /* documented above */
    inline ThisType & Divide(const value_type scalar)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi< typename vctStoreBackBinaryOperations<value_type>::Division >::
            Run(*this, scalar);
        return *this;
    }

    /* documented above */
    inline ThisType & ClipAbove(const value_type upperBound)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi< typename vctStoreBackBinaryOperations<value_type>::Minimum >::
            Run(*this, upperBound);
        return *this;
    }

    /* documented above */
    inline ThisType & ClipBelow(const value_type lowerBound)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSi< typename vctStoreBackBinaryOperations<value_type>::Maximum >::
            Run(*this, lowerBound);
        return *this;
    }

    /* documented above */
    inline ThisType & operator += (const value_type scalar)
    {
        return this->Add(scalar);
    }

    /* documented above */
    inline ThisType & operator -= (const value_type scalar)
    {
        return this->Subtract(scalar);
    }

    /* documented above */
    inline ThisType & operator *= (const value_type scalar)
    {
        return this->Multiply(scalar);
    }

    /* documented above */
    inline ThisType & operator /= (const value_type scalar)
    {
        return this->Divide(scalar);
    }
    //@}


    template <class __nArrayOwnerType>
    inline ThisType & AddProductOf(const value_type scalar,
                                   const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioSiNi<typename vctStoreBackBinaryOperations<value_type>::Addition,
            typename vctBinaryOperations<value_type>::Multiplication >::
            Run(*this, scalar, otherNArray);

        return *this;
    }


    template <class __nArrayOwnerType1, class __nArrayOwnerType2>
    inline ThisType & AddElementwiseProductOf(const vctDynamicConstNArrayBase<__nArrayOwnerType1, value_type, DIMENSION> & nArray1,
                                              const vctDynamicConstNArrayBase<__nArrayOwnerType2, value_type, DIMENSION> & nArray2)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NioNiNi<typename vctStoreBackBinaryOperations<value_type>::Addition,
            typename vctBinaryOperations<value_type>::Multiplication >::
            Run(*this, nArray1, nArray2);

        return *this;
    }


    /*! \name Unary elementwise operations.
      Store the result of op(nArray) to another nArray. */
    //@{
    /*! Unary elementwise operations on an nArray.  For each element of
      the nArray "this", performs \f$ this[i] \leftarrow
      op(otherNArray[i])\f$ where \f$op\f$ can calculate the absolute
      value (AbsOf) or the opposite (NegationOf).

      \param otherNArray The operand of the unary operation.

      \return The nArray "this" modified.
    */
    template <class __nArrayOwnerType>
    inline ThisType & AbsOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNi<typename vctUnaryOperations<value_type>::AbsValue>::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & NegationOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNi<typename vctUnaryOperations<value_type>::Negation>::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & FloorOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNi<typename vctUnaryOperations<value_type>::Floor>::
            Run(*this, otherNArray);
        return *this;
    }

    /* documented above */
    template <class __nArrayOwnerType>
    inline ThisType & CeilOf(const vctDynamicConstNArrayBase<__nArrayOwnerType, value_type, DIMENSION> & otherNArray)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            NoNi<typename vctUnaryOperations<value_type>::Ceil>::
            Run(*this, otherNArray);
        return *this;
    }

    //@}

    /*! \name Store back unary elementwise operations.
      Store the result of op(this) to this nArray. */
    //@{
    /*! Unary elementwise operations on an nArray.  For each element of
      the nArray "this", performs \f$ this[i] \leftarrow
      op(this[i])\f$ where \f$op\f$ can calculate the absolute
      value (AbsSelf) or the opposite (NegationSelf).

      \return The nArray "this" modified.
    */
    inline ThisType & AbsSelf(void)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            Nio<typename vctStoreBackUnaryOperations<value_type>::MakeAbs>::
            Run(*this);
        return *this;
    }

    /* documented above */
    inline ThisType & NegationSelf(void)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            Nio<typename vctStoreBackUnaryOperations<value_type>::MakeNegation>::
            Run(*this);
        return *this;
    }

    /* documented above */
    inline ThisType & FloorSelf(void)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            Nio<typename vctStoreBackUnaryOperations<value_type>::MakeFloor>::
            Run(*this);
        return *this;
    }

    /* documented above */
    inline ThisType & CeilSelf(void)
    {
        vctDynamicNArrayLoopEngines<DIMENSION>::template
            Nio<typename vctStoreBackUnaryOperations<value_type>::MakeCeil>::
            Run(*this);
        return *this;
    }
    //@}
};


#endif // _vctDynamicNArrayBase_h