File: MatrixBase.h

package info (click to toggle)
rcpp 1.0.10-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 11,432 kB
  • sloc: ansic: 44,024; cpp: 40,602; sh: 53; makefile: 2
file content (197 lines) | stat: -rw-r--r-- 6,850 bytes parent folder | download | duplicates (7)
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
// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*-
//
// MatrixBase.h: Rcpp R/C++ interface class library --
//
// Copyright (C) 2010 - 2016 Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2016        Dirk Eddelbuettel and Romain Francois and Nathan Russell
//               
// This file is part of Rcpp.
//
// Rcpp is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// Rcpp is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Rcpp.  If not, see <http://www.gnu.org/licenses/>.

#ifndef Rcpp__vector__MatrixBase_h
#define Rcpp__vector__MatrixBase_h

#include <Rcpp/sugar/matrix/tools.h>

namespace Rcpp{

    /** a base class for vectors, modelled after the CRTP */
    template <int RTYPE, bool na, typename MATRIX>
    class MatrixBase : public traits::expands_to_logical__impl<RTYPE> {
    public:
        struct r_type : traits::integral_constant<int,RTYPE>{} ;
        struct r_matrix_interface {} ;
        struct can_have_na : traits::integral_constant<bool,na>{} ;
        typedef typename traits::storage_type<RTYPE>::type stored_type ;

        MATRIX& get_ref(){
            return static_cast<MATRIX&>(*this) ;
        }

        inline stored_type operator()( int i, int j) const {
            return static_cast<const MATRIX*>(this)->operator()(i, j) ;
        }

        inline R_xlen_t size() const { return static_cast<const MATRIX&>(*this).size() ; }
        inline R_xlen_t nrow() const { return static_cast<const MATRIX&>(*this).nrow() ; }
        inline R_xlen_t ncol() const { return static_cast<const MATRIX&>(*this).ncol() ; }

        static MATRIX eye(int n) {
            const bool enabled = 
                traits::is_arithmetic<stored_type>::value || 
                traits::same_type<stored_type, Rcomplex>::value;
            (void)sizeof(traits::allowed_matrix_type<enabled>);
            
            return MATRIX::diag(n, traits::one_type<stored_type>());
        }
        
        static MATRIX ones(int n) {
            const bool enabled = 
                traits::is_arithmetic<stored_type>::value || 
                traits::same_type<stored_type, Rcomplex>::value;
            (void)sizeof(traits::allowed_matrix_type<enabled>);
            
            MATRIX res(n, n);
            std::fill(
                res.begin(), res.end(), 
                traits::one_type<stored_type>()
            );
            return res;
        }
        
        static MATRIX zeros(int n) {
            const bool enabled = 
                traits::is_arithmetic<stored_type>::value || 
                traits::same_type<stored_type, Rcomplex>::value;
            (void)sizeof(traits::allowed_matrix_type<enabled>);
            
            return MATRIX(n, n);
        }

        class iterator {
        public:
            typedef stored_type reference ;
            typedef stored_type* pointer ;
            typedef R_xlen_t difference_type ;
            typedef stored_type value_type;
            typedef std::random_access_iterator_tag iterator_category ;

            iterator( const MatrixBase& object_, R_xlen_t index_ ) :
                object(object_), i(0), j(0), nr(object_.nrow()), nc(object_.ncol()) {

                update_index( index_) ;
            }

            iterator( const iterator& other) :
                object(other.object), i(other.i), j(other.j), nr(other.nr), nc(other.nc){}

            inline iterator& operator++(){
                i++ ;
                if( i == nr ){
                    j++ ;
                    i=0 ;
                }
                return *this ;
            }
            inline iterator operator++(int){
                iterator orig(*this) ;
                ++(*this) ;
                return orig ;
            }

            inline iterator& operator--(){
                i-- ;
                if( i == -1 ){
                    j-- ;
                    i = nr - 1 ;
                }
                return *this ;
            }
            inline iterator operator--(int){
                iterator orig(*this) ;
                --(*this) ;
                return orig ;
            }

            inline iterator operator+(difference_type n) const {
                return iterator( object, i + (j*nr) + n ) ;
            }
            inline iterator operator-(difference_type n) const {
                return iterator( object, i + (j*nr) - n ) ;
            }

            inline iterator& operator+=(difference_type n) {
                update_index( i + j*nr + n );
                return *this ;
            }
            inline iterator& operator-=(difference_type n) {
                update_index( i + j*nr - n );
                return *this ;
            }

            inline reference operator*() {
                return object(i,j) ;
            }
            inline pointer operator->(){
                return &object(i,j) ;
            }

            inline bool operator==( const iterator& y) const {
                return ( i == y.i && j == y.j ) ;
            }
            inline bool operator!=( const iterator& y) const {
                return ( i != y.i || j != y.j ) ;
            }
            inline bool operator<( const iterator& other ) const {
                return index() < other.index() ;
            }
            inline bool operator>( const iterator& other ) const {
                return index() > other.index() ;
            }
            inline bool operator<=( const iterator& other ) const {
                return index() <= other.index() ;
            }
            inline bool operator>=( const iterator& other ) const {
                return index() >= other.index() ;
            }

            inline difference_type operator-(const iterator& other) const {
                return index() - other.index() ;
            }


        private:
            const MatrixBase& object ;
            int i, j ;
            int nr, nc ;

            inline void update_index( int index_ ){
                i = internal::get_line( index_, nr );
                j = internal::get_column( index_, nr, i ) ;
            }

            inline R_xlen_t index() const {
                return i + nr * j ;
            }

        } ;

        inline iterator begin() const { return iterator(*this, 0) ; }
        inline iterator end() const { return iterator(*this, size() ) ; }

    } ;

} // namespace Rcpp
#endif