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.
  29
  30 If a native (i.e. supported directly by the compiler) 64 bit integer type was
  31 found a typedef {\it wxLongLong\_t} will be defined to correspond it.
  32
  33 \wxheading{Derived from}
  34
  35 No base class
  36
  37 \wxheading{Include files}
  38
  39 <wx/longlong.h>
  40
  41 \latexignore{\rtfignore{\wxheading{Members}}}
  42
  43 \membersection{wxLongLong::wxLongLong}\label{wxlonglongwxlonglongdef}
  44
  45 \func{}{wxLongLong}{\void}
  46
  47 Default constructor initializes the object to 0.
  48
  49 \membersection{wxLongLong::wxLongLong}\label{wxlonglongwxlonglongll}
  50
  51 \func{}{wxLongLong}{\param{wxLongLong\_t }{ll}}
  52
  53 Constructor from native long long (only for compilers supporting it).
  54
  55 \membersection{wxLongLong::wxLongLong}\label{wxlonglongwxlonglong}
  56
  57 \func{}{wxLongLong}{\param{long }{hi}, \param{unsigned long }{lo}}
  58
  59 Constructor from 2 longs: the high and low part are combined into one
  60 wxLongLong.
  61
  62 \membersection{wxLongLong::operator=}\label{wxlonglongoperatorassign}
  63
  64 \func{wxLongLong\& operator}{operator=}{\param{wxLongLong\_t }{ll}}
  65
  66 Assignment operator from native long long (only for compilers supporting it).
  67
  68 \membersection{wxLongLong::Abs}\label{wxlonglongabs}
  69
  70 \constfunc{wxLongLong}{Abs}{\void}
  71
  72 \func{wxLongLong\&}{Abs}{\void}
  73
  74 Returns an absolute value of wxLongLong - either making a copy (const version)
  75 or modifying it in place (the second one).  Not in wxULongLong.
  76
  77 \membersection{wxLongLong::Assign}\label{wxlonglongassign}
  78
  79 \func{wxLongLong\&}{Assign}{\param{double }{d}}
  80
  81 This allows to convert a double value to wxLongLong type. Such conversion is
  82 not always possible in which case the result will be silently truncated in a
  83 platform-dependent way.  Not in wxULongLong.
  84
  85 \membersection{wxLongLong::GetHi}\label{wxlonglonggethi}
  86
  87 \constfunc{long}{GetHi}{\void}
  88
  89 Returns the high 32 bits of 64 bit integer.
  90
  91 \membersection{wxLongLong::GetLo}\label{wxlonglonggetlo}
  92
  93 \constfunc{unsigned long}{GetLo}{\void}
  94
  95 Returns the low 32 bits of 64 bit integer.
  96
  97 \membersection{wxLongLong::GetValue}\label{wxlonglonggetvalue}
  98
  99 \constfunc{wxLongLong\_t}{GetValue}{\void}
 100
 101 Convert to native long long (only for compilers supporting it)
 102
 103 \membersection{wxLongLong::ToLong}\label{wxlonglongtolong}
 104
 105 \constfunc{long}{ToLong}{\void}
 106
 107 Truncate wxLongLong to long. If the conversion loses data (i.e. the wxLongLong
 108 value is outside the range of built-in long type), an assert will be triggered
 109 in debug mode.
 110
 111 \membersection{wxLongLong::ToString}\label{wxlonglongtostring}
 112
 113 \constfunc{wxString}{ToString}{\void}
 114
 115 Returns the string representation of a wxLongLong.
 116
 117 \membersection{wxLongLong::operator$+$}\label{wxlonglongoperatorplus}
 118
 119 \constfunc{wxLongLong}{operator$+$}{\param{const wxLongLong\& }{ll}}
 120
 121 Adds 2 wxLongLongs together and returns the result.
 122
 123 \membersection{wxLongLong::operator$+=$}\label{wxlonglongoperatorplusassign}
 124
 125 \func{wxLongLong\&}{operator+}{\param{const wxLongLong\& }{ll}}
 126
 127 Add another wxLongLong to this one.
 128
 129 \membersection{wxLongLong::operator$++$}\label{wxlonglongoperatorinc}
 130
 131 \func{wxLongLong\&}{operator$++$}{\void}
 132
 133 \func{wxLongLong\&}{operator$++$}{\param{int}{}}
 134
 135 Pre/post increment operator.
 136
 137 \membersection{wxLongLong::operator$-$}\label{wxlonglongoperatorunaryminus}
 138
 139 \constfunc{wxLongLong}{operator$-$}{\void}
 140
 141 Returns the value of this wxLongLong with opposite sign.  Not in wxULongLong.
 142
 143 \membersection{wxLongLong::operator$-$}\label{wxlonglongoperatorminus}
 144
 145 \constfunc{wxLongLong}{operator$-$}{\param{const wxLongLong\& }{ll}}
 146
 147 Substracts 2 wxLongLongs and returns the result.
 148
 149 \membersection{wxLongLong::operator$-=$}\label{wxlonglongoperatorminusassign}
 150
 151 \func{wxLongLong\&}{operator-}{\param{const wxLongLong\& }{ll}}
 152
 153 Substracts another wxLongLong from this one.
 154
 155 \membersection{wxLongLong::operator$--$}\label{wxlonglongoperatordec}
 156
 157 \func{wxLongLong\&}{operator$--$}{\void}
 158
 159 \func{wxLongLong\&}{operator$--$}{\param{int}{}}
 160
 161 Pre/post decrement operator.
 162
 163 % TODO document all other arithmetics operations: shifts, multiplication,
 164 % division, bitwise, comparison
 165