File: VectorBase.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 (173 lines) | stat: -rw-r--r-- 5,152 bytes parent folder | download | duplicates (5)
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
// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; tab-width: 8 -*-
//
// VectorBase.h: Rcpp R/C++ interface class library --
//
// Copyright (C) 2010 - 2013 Dirk Eddelbuettel and Romain Francois
//
// 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__VectorBase_h
#define Rcpp__vector__VectorBase_h

namespace Rcpp{

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

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

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

	inline stored_type operator[]( R_xlen_t i) const {
	    return static_cast<const VECTOR*>(this)->operator[](i) ;
	}

	inline R_xlen_t size() const { return static_cast<const VECTOR*>(this)->size() ; }
	
	// We now have the structure to correct const-correctness, but without
    // major changes to the proxy mechanism, we cannot do it correctly.  As
    // a result, it turns out that both Vector iterators are effectively
    // const, but this has always been the way it is so we won't break any
    // compatibility.  TODO: Fix proxies and make this const correct.
	struct iter_traits
	{
	    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 ;
	};
	
	struct const_iter_traits
	{
	    typedef stored_type reference ;
		typedef stored_type const * pointer ;
		typedef R_xlen_t difference_type ;
		typedef const stored_type value_type;
		typedef std::random_access_iterator_tag iterator_category ;
	};
	
	template< typename TRAITS >
	class iter_base {
	public:
		typedef typename TRAITS::reference reference;
		typedef typename TRAITS::pointer pointer;
		typedef typename TRAITS::difference_type difference_type;
		typedef typename TRAITS::value_type value_type;
		typedef typename TRAITS::iterator_category iterator_category;

		iter_base( const VectorBase& object_, R_xlen_t index_ ) : object(object_.get_ref()), index(index_){}
		
		inline iter_base& operator++(){
			index++ ;
			return *this ;
		}
		inline iter_base operator++(int){
			iterator orig(*this);
		    ++(*this) ;
			return orig ;
		}

		inline iter_base& operator--(){
			index-- ;
			return *this ;
		}
		inline iter_base operator--(int){
			iterator orig(*this);
		    --(*this) ;
			return orig ;
		}

		inline iter_base operator+(difference_type n) const {
			return iterator( object, index+n ) ;
		}
		inline iter_base operator-(difference_type n) const {
			return iterator( object, index-n ) ;
		}

		inline iter_base& operator+=(difference_type n) {
			index += n ;
			return *this ;
		}
		inline iter_base& operator-=(difference_type n) {
			index -= n;
			return *this ;
		}

		inline reference operator[](R_xlen_t i){
		    return object[index+i] ;
		}

		inline reference operator*() {
			return object[index] ;
		}
		inline pointer operator->(){
			return &object[index] ;
		}

		inline bool operator==( const iter_base& y) const {
			return ( index == y.index ) ;
		}
		inline bool operator!=( const iter_base& y) const {
			return ( index != y.index ) ;
		}
		inline bool operator<( const iter_base& other ) const {
			return index < other.index ;
		}
		inline bool operator>( const iter_base& other ) const {
			return index > other.index ;
		}
		inline bool operator<=( const iter_base& other ) const {
			return index <= other.index ;
		}
		inline bool operator>=( const iter_base& other ) const {
			return index >= other.index ;
		}

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


	private:
		const VECTOR& object ;
		R_xlen_t index;
	} ;
	
    typedef iter_base< iter_traits > iterator;
    typedef iter_base< const_iter_traits > const_iterator;
	
	inline const_iterator begin() const { return const_iterator(*this, 0) ; }
	inline const_iterator end() const { return const_iterator(*this, size() ) ; }
	
	inline const_iterator cbegin() const { return const_iterator(*this, 0) ; }
	inline const_iterator cend() const { return const_iterator(*this, size() ) ; }

} ;

} // namespace Rcpp
#endif