]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/longlong.tex
cleanup
[wxWidgets.git] / docs / latex / wx / longlong.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: longlong.tex
3 %% Purpose: wxLongLong documentation
4 %% Author: Vadim Zeitlin
5 %% Modified by:
6 %% Created: 07.03.00
7 %% RCS-ID: $Id$
8 %% Copyright: (c) Vadim Zeitlin
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxLongLong}}\label{wxlonglong}
13
14 This class represents a signed 64 bit long number. It is implemented using the
15 native 64 bit type where available (machines with 64 bit longs or compilers
16 which have (an analog of) {\it long long} type) and uses the emulation code in
17 the other cases which ensures that it is the most efficient solution for
18 working with 64 bit integers independently of the architecture.
19
20 wxLongLong defines all usual arithmetic operations such as addition,
21 subtraction, bitwise shifts and logical operations as well as multiplication
22 and division (not yet for the machines without native {\it long long}). It
23 also has operators for implicit construction from and conversion to the native
24 {\it long long} type if it exists and {\it long}.
25
26 You would usually use this type in exactly the same manner as any other
27 (built-in) arithmetic type. Note that wxLongLong is a signed type, if you
28 want unsigned values use wxULongLong which has exactly the same API as
29 wxLongLong except when explicitly mentioned otherwise.
30
31 If a native (i.e. supported directly by the compiler) 64 bit integer type was
32 found to exist, {\it wxLongLong\_t} macro will be defined to correspond to it.
33 Also, in this case only, two additional macros will be defined:
34 \helpref{wxLongLongFmtSpec}{wxlonglongfmtspec} for printing 64 bit integers
35 using the standard {\tt printf()} function (but see also
36 \helpref{ToString()}{wxlonglongtostring} for a more portable solution) and
37 \helpref{wxLL}{wxll} for defining 64 bit integer compile-time constants.
38
39 \wxheading{Derived from}
40
41 No base class
42
43 \wxheading{Include files}
44
45 <wx/longlong.h>
46
47 \wxheading{Library}
48
49 \helpref{wxBase}{librarieslist}
50
51 \latexignore{\rtfignore{\wxheading{Members}}}
52
53
54 \membersection{wxLongLong::wxLongLong}\label{wxlonglongwxlonglongdef}
55
56 \func{}{wxLongLong}{\void}
57
58 Default constructor initializes the object to 0.
59
60
61 \membersection{wxLongLong::wxLongLong}\label{wxlonglongwxlonglongll}
62
63 \func{}{wxLongLong}{\param{wxLongLong\_t }{ll}}
64
65 Constructor from native long long (only for compilers supporting it).
66
67
68 \membersection{wxLongLong::wxLongLong}\label{wxlonglongwxlonglong}
69
70 \func{}{wxLongLong}{\param{long }{hi}, \param{unsigned long }{lo}}
71
72 Constructor from 2 longs: the high and low part are combined into one
73 wxLongLong.
74
75
76 \membersection{wxLongLong::operator=}\label{wxlonglongoperatorassign}
77
78 \func{wxLongLong\& operator}{operator=}{\param{wxLongLong\_t }{ll}}
79
80 Assignment operator from native long long (only for compilers supporting it).
81
82
83 \membersection{wxLongLong::operator=}\label{wxlonglongoperatorassignull}
84
85 \func{wxLongLong\& operator}{operator=}{\param{wxULongLong\_t }{ll}}
86
87 Assignment operator from native unsigned long long (only for compilers
88 supporting it).
89
90 \newsince{2.7.0}
91
92 \membersection{wxLongLong::operator=}\label{wxlonglongoperatorassignlong}
93
94 \func{wxLongLong\& operator}{operator=}{\param{long }{l}}
95
96 Assignment operator from long.
97
98 \newsince{2.7.0}
99
100 \membersection{wxLongLong::operator=}\label{wxlonglongoperatorassignulong}
101
102 \func{wxLongLong\& operator}{operator=}{\param{unsigned long }{l}}
103
104 Assignment operator from unsigned long.
105
106 \newsince{2.7.0}
107
108 \membersection{wxLongLong::operator=}\label{wxlonglongoperatorassignulonglong}
109
110 \func{wxLongLong\& operator}{operator=}{\param{const wxULongLong \& }{ll}}
111
112 Assignment operator from unsigned long long. The sign bit will be copied too.
113
114 \newsince{2.7.0}
115
116 \membersection{wxLongLong::Abs}\label{wxlonglongabs}
117
118 \constfunc{wxLongLong}{Abs}{\void}
119
120 \func{wxLongLong\&}{Abs}{\void}
121
122 Returns an absolute value of wxLongLong - either making a copy (const version)
123 or modifying it in place (the second one). Not in wxULongLong.
124
125
126 \membersection{wxLongLong::Assign}\label{wxlonglongassign}
127
128 \func{wxLongLong\&}{Assign}{\param{double }{d}}
129
130 This allows to convert a double value to wxLongLong type. Such conversion is
131 not always possible in which case the result will be silently truncated in a
132 platform-dependent way. Not in wxULongLong.
133
134
135 \membersection{wxLongLong::GetHi}\label{wxlonglonggethi}
136
137 \constfunc{long}{GetHi}{\void}
138
139 Returns the high 32 bits of 64 bit integer.
140
141
142 \membersection{wxLongLong::GetLo}\label{wxlonglonggetlo}
143
144 \constfunc{unsigned long}{GetLo}{\void}
145
146 Returns the low 32 bits of 64 bit integer.
147
148
149 \membersection{wxLongLong::GetValue}\label{wxlonglonggetvalue}
150
151 \constfunc{wxLongLong\_t}{GetValue}{\void}
152
153 Convert to native long long (only for compilers supporting it)
154
155
156 \membersection{wxLongLong::ToDouble}\label{wxlonglonggetdouble}
157
158 \constfunc{double}{ToDouble}{\void}
159
160 Returns the value as \texttt{double}.
161
162
163 \membersection{wxLongLong::ToLong}\label{wxlonglongtolong}
164
165 \constfunc{long}{ToLong}{\void}
166
167 Truncate wxLongLong to long. If the conversion loses data (i.e. the wxLongLong
168 value is outside the range of built-in long type), an assert will be triggered
169 in debug mode.
170
171
172 \membersection{wxLongLong::ToString}\label{wxlonglongtostring}
173
174 \constfunc{wxString}{ToString}{\void}
175
176 Returns the string representation of a wxLongLong.
177
178
179 \membersection{wxLongLong::operator$+$}\label{wxlonglongoperatorplus}
180
181 \constfunc{wxLongLong}{operator$+$}{\param{const wxLongLong\& }{ll}}
182
183 Adds 2 wxLongLongs together and returns the result.
184
185
186 \membersection{wxLongLong::operator$+=$}\label{wxlonglongoperatorplusassign}
187
188 \func{wxLongLong\&}{operator+}{\param{const wxLongLong\& }{ll}}
189
190 Add another wxLongLong to this one.
191
192
193 \membersection{wxLongLong::operator$++$}\label{wxlonglongoperatorinc}
194
195 \func{wxLongLong\&}{operator$++$}{\void}
196
197 \func{wxLongLong\&}{operator$++$}{\param{int}{}}
198
199 Pre/post increment operator.
200
201
202 \membersection{wxLongLong::operator$-$}\label{wxlonglongoperatorunaryminus}
203
204 \constfunc{wxLongLong}{operator$-$}{\void}
205
206 Returns the value of this wxLongLong with opposite sign. Not in wxULongLong.
207
208
209 \membersection{wxLongLong::operator$-$}\label{wxlonglongoperatorminus}
210
211 \constfunc{wxLongLong}{operator$-$}{\param{const wxLongLong\& }{ll}}
212
213 Subtracts 2 wxLongLongs and returns the result.
214
215
216 \membersection{wxLongLong::operator$-=$}\label{wxlonglongoperatorminusassign}
217
218 \func{wxLongLong\&}{operator-}{\param{const wxLongLong\& }{ll}}
219
220 Subtracts another wxLongLong from this one.
221
222
223 \membersection{wxLongLong::operator$--$}\label{wxlonglongoperatordec}
224
225 \func{wxLongLong\&}{operator$--$}{\void}
226
227 \func{wxLongLong\&}{operator$--$}{\param{int}{}}
228
229 Pre/post decrement operator.
230
231 % TODO document all other arithmetics operations: shifts, multiplication,
232 % division, bitwise, comparison
233