Core Function Atof - Revision history

UberFoX: /* Example */

2015-09-21T14:34:16Z

Example

← Older revision		Revision as of 14:34, 21 September 2015
Line 79:		Line 79:
	// so it is able to find a valid floating-point		// so it is able to find a valid floating-point
	$var = atof( "Hello 777.42 h789", null, -3 );		$var = atof( "Hello 777.42 h789", null, -3 );
−	say $var; // Prints: ~~77.42~~	+	say $var; // Prints: 789
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: 1 revision

2015-06-14T12:37:30Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:41:02Z

1 revision

← Older revision

Revision as of 21:41, 11 August 2014

UberFoX at 08:29, 4 September 2013

2013-09-04T08:29:15Z

← Older revision		Revision as of 08:29, 4 September 2013
Line 1:		Line 1:
	<pre>		<pre>
−	Atof( <variable>, <count> )	+	Atof( <variable>, <count>, <start> )
	</pre>		</pre>

Line 30:		Line 30:

	See example.		See example.
		+
		+	==== start ====
		+
		+	Optional; Start position to begin searching the haystack from.
		+
		+	Can be negative this will cause it to start from haystack length - abs(start) instead.
		+
		+	Default: 0

	=== Return Value ===		=== Return Value ===
Line 57:		Line 65:
	say $var; // Prints: 77.42		say $var; // Prints: 77.42
	say $count; // Prints: 5 // Since there were 5 chars in the floating-point		say $count; // Prints: 5 // Since there were 5 chars in the floating-point
		+	</syntaxhighlight>
		+
		+	Example of using start parameter
		+	<syntaxhighlight lang="sputnik">
		+	// Search begins at index 6 of the string so it is able to find a valid floating-point
		+	$var = atof( "Hello 777.42 hmmm", null, 6 );
		+	say $var; // Prints: 77.42
		+	</syntaxhighlight>
		+
		+	Example of using negative start parameter
		+	<syntaxhighlight lang="sputnik">
		+	// Search begins at index -3 (-3 turns out to be haystack length - abs(-3) of the string
		+	// so it is able to find a valid floating-point
		+	$var = atof( "Hello 777.42 h789", null, -3 );
		+	say $var; // Prints: 77.42
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX at 21:15, 2 September 2013

2013-09-02T21:15:46Z

← Older revision		Revision as of 21:15, 2 September 2013
Line 4:		Line 4:

	=== Description ===		=== Description ===
		+
		+	Convert string to Double.

	Parses the string, interpreting its content as a floating point number and returns its value as a double.		Parses the string, interpreting its content as a floating point number and returns its value as a double.

UberFoX at 21:14, 2 September 2013

2013-09-02T21:14:26Z

← Older revision		Revision as of 21:14, 2 September 2013
Line 39:		Line 39:
	=== Remarks ===		=== Remarks ===

−	~~None~~	+	This is useful for when you wish to exact a number from a string even if the entire string is not suitable as a number and would normally return 0.
		+
		+	Using this you can extract the number you desire advance along the string using the count and continue.

	=== Example ===		=== Example ===

UberFoX: Created page with "

 Atof( ,  )

=== Description === Parses the string, interpreting its content as a floating point number and returns its value as a double. The func..."

2013-09-02T20:57:38Z

Created page with "<pre> Atof( <variable>, <count> ) </pre> === Description === Parses the string, interpreting its content as a floating point number and returns its value as a double. The func..."

New page

<pre>
Atof( <variable>, <count> )
</pre>

=== Description ===

Parses the string, interpreting its content as a floating point number and returns its value as a double.

The function first discards as many whitespace characters (as in isspace) as necessary until the first non-whitespace character is found.

Then, starting from this character, takes as many characters as possible that are valid following a syntax resembling that of floating point literals (see below), and interprets them as a numerical value.

The rest of the string after the last valid character is ignored and has no effect on the behavior of this function.

If the first sequence of non-whitespace characters in string does not form a valid floating-point number as just defined, or if no such sequence exists because either string is empty or contains only whitespace characters, no conversion is performed and the function returns 0.0.

=== Parameters ===

==== variable ====

A string beginning with the representation of a floating-point number.

(It does not need to fully be a floating-point number just begin with one)

==== count ====

Optional; If you supply a variable for this parameter it will be given the number of characters that the floating-point number is made up from out of the string.

See example.

=== Return Value ===

On success, the function returns the converted floating point number as a double value.

If no valid conversion could be performed, the function returns zero (0.0).

If the converted value would be out of the range of representable values by a double, it will set to the @Double_Max, @Double_Min or 0.0 depending on the issue at hand.

=== Remarks ===

None

=== Example ===

<syntaxhighlight lang="sputnik">
$var = atof( "77.42Hello" );
say $var; // Prints: 77.42
</syntaxhighlight>

Example of getting how many characters were extracted from the string
<syntaxhighlight lang="sputnik">
$var = atof( "77.42Hello", $count );
say $var; // Prints: 77.42
say $count; // Prints: 5 // Since there were 5 chars in the floating-point
</syntaxhighlight>

[[Category:Core Function]]