libs-base/Documentation/gsdoc/NSNumber.html

344 lines
9.8 KiB
HTML
Raw Normal View History

<html><head>
<title>NSNumber</title>
</head>
<body>
<a href ="NSNull.html">[Previous] </a>
<a href ="Base.html">[Up] </a>
<a href ="NSNumberFormatter.html">[Next] </a>
<h1>NSNumber</h1>
<h3>Authors </h3>
<dl>
<dt><a href ="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
<dd>
</dl>
<p>Version: $Revision$</p>
<p>Date: $Date$</p>
<h2><a name ="cont-0">NSNumber</a></h2>
<h2><a name ="NSNumber">NSNumber</a></h2>
<p><b>Declared in: </b> Foundation/NSValue.h</p>
<p><b>Inherits from: </b> NSValue</p>
<p><b>Conforms to: </b> NSCoding
</p>
<hr>
<h2>Instance Variables </h2>
<ul>
</ul>
<h2>Methods </h2>
<ul>
<li ><a href ="NSNumber.html#method-0">+numberWithBool:</a>
<li ><a href ="NSNumber.html#method-1">+numberWithChar:</a>
<li ><a href ="NSNumber.html#method-2">+numberWithDouble:</a>
<li ><a href ="NSNumber.html#method-3">+numberWithFloat:</a>
<li ><a href ="NSNumber.html#method-4">+numberWithInt:</a>
<li ><a href ="NSNumber.html#method-5">+numberWithLong:</a>
<li ><a href ="NSNumber.html#method-6">+numberWithLongLong:</a>
<li ><a href ="NSNumber.html#method-7">+numberWithShort:</a>
<li ><a href ="NSNumber.html#method-8">+numberWithUnsignedChar:</a>
<li ><a href ="NSNumber.html#method-9">+numberWithUnsignedInt:</a>
<li ><a href ="NSNumber.html#method-10">+numberWithUnsignedLong:</a>
<li ><a href ="NSNumber.html#method-11">+numberWithUnsignedLongLong:</a>
<li ><a href ="NSNumber.html#method-12">+numberWithUnsignedShort:</a>
<li ><a href ="NSNumber.html#method-13">-boolValue</a>
<li ><a href ="NSNumber.html#method-14">-charValue</a>
<li ><a href ="NSNumber.html#method-15">-compare:</a>
<li ><a href ="NSNumber.html#method-16">-decimalValue</a>
<li ><a href ="NSNumber.html#method-17">-description</a>
<li ><a href ="NSNumber.html#method-18">-descriptionWithLocale:</a>
<li ><a href ="NSNumber.html#method-19">-doubleValue</a>
<li ><a href ="NSNumber.html#method-20">-floatValue</a>
<li ><a href ="NSNumber.html#method-21">-initWithBool:</a>
<li ><a href ="NSNumber.html#method-22">-initWithChar:</a>
<li ><a href ="NSNumber.html#method-23">-initWithDouble:</a>
<li ><a href ="NSNumber.html#method-24">-initWithFloat:</a>
<li ><a href ="NSNumber.html#method-25">-initWithInt:</a>
<li ><a href ="NSNumber.html#method-26">-initWithLong:</a>
<li ><a href ="NSNumber.html#method-27">-initWithLongLong:</a>
<li ><a href ="NSNumber.html#method-28">-initWithShort:</a>
<li ><a href ="NSNumber.html#method-29">-initWithUnsignedChar:</a>
<li ><a href ="NSNumber.html#method-30">-initWithUnsignedInt:</a>
<li ><a href ="NSNumber.html#method-31">-initWithUnsignedLong:</a>
<li ><a href ="NSNumber.html#method-32">-initWithUnsignedLongLong:</a>
<li ><a href ="NSNumber.html#method-33">-initWithUnsignedShort:</a>
<li ><a href ="NSNumber.html#method-34">-intValue</a>
<li ><a href ="NSNumber.html#method-35">-isEqualToNumber:</a>
<li ><a href ="NSNumber.html#method-36">-longLongValue</a>
<li ><a href ="NSNumber.html#method-37">-longValue</a>
<li ><a href ="NSNumber.html#method-38">-shortValue</a>
<li ><a href ="NSNumber.html#method-39">-stringValue</a>
<li ><a href ="NSNumber.html#method-40">-unsignedCharValue</a>
<li ><a href ="NSNumber.html#method-41">-unsignedIntValue</a>
<li ><a href ="NSNumber.html#method-42">-unsignedLongLongValue</a>
<li ><a href ="NSNumber.html#method-43">-unsignedLongValue</a>
<li ><a href ="NSNumber.html#method-44">-unsignedShortValue</a>
</ul>
<hr><h2>Class Methods </h2>
<h3><a name ="method-0">numberWithBool:</a></h3>
+ (NSNumber*) <b>numberWithBool:</b> (BOOL)value;<br>
<hr>
<h3><a name ="method-1">numberWithChar:</a></h3>
+ (NSNumber*) <b>numberWithChar:</b> (char)value;<br>
<hr>
<h3><a name ="method-2">numberWithDouble:</a></h3>
+ (NSNumber*) <b>numberWithDouble:</b> (double)value;<br>
<hr>
<h3><a name ="method-3">numberWithFloat:</a></h3>
+ (NSNumber*) <b>numberWithFloat:</b> (float)value;<br>
<hr>
<h3><a name ="method-4">numberWithInt:</a></h3>
+ (NSNumber*) <b>numberWithInt:</b> (int)value;<br>
<hr>
<h3><a name ="method-5">numberWithLong:</a></h3>
+ (NSNumber*) <b>numberWithLong:</b> (long int)value;<br>
<hr>
<h3><a name ="method-6">numberWithLongLong:</a></h3>
+ (NSNumber*) <b>numberWithLongLong:</b> (long long int)value;<br>
<hr>
<h3><a name ="method-7">numberWithShort:</a></h3>
+ (NSNumber*) <b>numberWithShort:</b> (short int)value;<br>
<hr>
<h3><a name ="method-8">numberWithUnsignedChar:</a></h3>
+ (NSNumber*) <b>numberWithUnsignedChar:</b> (unsigned char)value;<br>
<hr>
<h3><a name ="method-9">numberWithUnsignedInt:</a></h3>
+ (NSNumber*) <b>numberWithUnsignedInt:</b> (unsigned int)value;<br>
<hr>
<h3><a name ="method-10">numberWithUnsignedLong:</a></h3>
+ (NSNumber*) <b>numberWithUnsignedLong:</b> (unsigned long int)value;<br>
<hr>
<h3><a name ="method-11">numberWithUnsignedLongLong:</a></h3>
+ (NSNumber*) <b>numberWithUnsignedLongLong:</b> (unsigned long long int)value;<br>
<hr>
<h3><a name ="method-12">numberWithUnsignedShort:</a></h3>
+ (NSNumber*) <b>numberWithUnsignedShort:</b> (unsigned short int)value;<br>
<hr>
<hr><h2>Instances Methods </h2>
<h3><a name ="method-13">boolValue</a></h3>
- (BOOL) <b>boolValue</b>;<br>
<hr>
<h3><a name ="method-14">charValue</a></h3>
- (char) <b>charValue</b>;<br>
<hr>
<h3><a name ="method-15">compare:</a></h3>
- (NSComparisonResult) <b>compare:</b> (NSNumber*)aNumber;<br>
<hr>
<h3><a name ="method-16">decimalValue</a></h3>
- (NSDecimal) <b>decimalValue</b>;<br>
<hr>
<h3><a name ="method-17">description</a></h3>
- (NSString*) <b>description</b>;<br>
Invokes descriptionWithLocale: using nil locale.
<hr>
<h3><a name ="method-18">descriptionWithLocale:</a></h3>
- (NSString*) <b>descriptionWithLocale:</b> (NSDictionary*)aLocale;<br>
<p>
Produces a string representation of the number. For a boolean
this will be either 'true' or 'false'. For other numbers the
format is produced using the initWithFormat:locale:... method
of NSString, and the format depends on the type of number as
follows -
</p>
<dl>
<dt>char
<dd>%i
<dt> short
<dd>%hi
<dt> int
<dd>%i
<dt> long
<dd>%li
<dt> long long
<dd>%li
<dt> unsigned char
<dd>%u
<dt> unsigned short
<dd>%hu
<dt> unsigned int
<dd>%u
<dt> unsigned long
<dd>%lu
<dt> unsigned long long
<dd>%lu
<dt> float
<dd>%0.7g
<dt> double
<dd>%0.16g
</dl>
<hr>
<h3><a name ="method-19">doubleValue</a></h3>
- (double) <b>doubleValue</b>;<br>
<hr>
<h3><a name ="method-20">floatValue</a></h3>
- (float) <b>floatValue</b>;<br>
<hr>
<h3><a name ="method-21">initWithBool:</a></h3>
- (id) <b>initWithBool:</b> (BOOL)value;<br>
<hr>
<h3><a name ="method-22">initWithChar:</a></h3>
- (id) <b>initWithChar:</b> (char)value;<br>
<hr>
<h3><a name ="method-23">initWithDouble:</a></h3>
- (id) <b>initWithDouble:</b> (double)value;<br>
<hr>
<h3><a name ="method-24">initWithFloat:</a></h3>
- (id) <b>initWithFloat:</b> (float)value;<br>
<hr>
<h3><a name ="method-25">initWithInt:</a></h3>
- (id) <b>initWithInt:</b> (int)value;<br>
<hr>
<h3><a name ="method-26">initWithLong:</a></h3>
- (id) <b>initWithLong:</b> (long int)value;<br>
<hr>
<h3><a name ="method-27">initWithLongLong:</a></h3>
- (id) <b>initWithLongLong:</b> (long long int)value;<br>
<hr>
<h3><a name ="method-28">initWithShort:</a></h3>
- (id) <b>initWithShort:</b> (short int)value;<br>
<hr>
<h3><a name ="method-29">initWithUnsignedChar:</a></h3>
- (id) <b>initWithUnsignedChar:</b> (unsigned char)value;<br>
<hr>
<h3><a name ="method-30">initWithUnsignedInt:</a></h3>
- (id) <b>initWithUnsignedInt:</b> (unsigned int)value;<br>
<hr>
<h3><a name ="method-31">initWithUnsignedLong:</a></h3>
- (id) <b>initWithUnsignedLong:</b> (unsigned long int)value;<br>
<hr>
<h3><a name ="method-32">initWithUnsignedLongLong:</a></h3>
- (id) <b>initWithUnsignedLongLong:</b> (unsigned long long int)value;<br>
<hr>
<h3><a name ="method-33">initWithUnsignedShort:</a></h3>
- (id) <b>initWithUnsignedShort:</b> (unsigned short int)value;<br>
<hr>
<h3><a name ="method-34">intValue</a></h3>
- (int) <b>intValue</b>;<br>
<hr>
<h3><a name ="method-35">isEqualToNumber:</a></h3>
- (BOOL) <b>isEqualToNumber:</b> (NSNumber*)aNumber;<br>
<hr>
<h3><a name ="method-36">longLongValue</a></h3>
- (long long int) <b>longLongValue</b>;<br>
<hr>
<h3><a name ="method-37">longValue</a></h3>
- (long int) <b>longValue</b>;<br>
<hr>
<h3><a name ="method-38">shortValue</a></h3>
- (short int) <b>shortValue</b>;<br>
<hr>
<h3><a name ="method-39">stringValue</a></h3>
- (NSString*) <b>stringValue</b>;<br>
Expivalent to descriptionWithLocale: using a nil locale.
<hr>
<h3><a name ="method-40">unsignedCharValue</a></h3>
- (unsigned char) <b>unsignedCharValue</b>;<br>
<hr>
<h3><a name ="method-41">unsignedIntValue</a></h3>
- (unsigned int) <b>unsignedIntValue</b>;<br>
<hr>
<h3><a name ="method-42">unsignedLongLongValue</a></h3>
- (unsigned long long int) <b>unsignedLongLongValue</b>;<br>
<hr>
<h3><a name ="method-43">unsignedLongValue</a></h3>
- (unsigned long int) <b>unsignedLongValue</b>;<br>
<hr>
<h3><a name ="method-44">unsignedShortValue</a></h3>
- (unsigned short int) <b>unsignedShortValue</b>;<br>
<hr>
</body>
</html>