Parse()
OutputVar := MfFloat.Parse(s)
OutputVar := MfFloat.Parse(s, style)
OutputVar := MfFloat.Parse(s, provider)
OutputVar := MfFloat.Parse(s, style, provider)
Converts the s representation of a number to its MfFloat equivalent
s
An string var of object convert.
Can be var or instance of MfChar, MfString
Returns MfFloat instance equivalent to the number contained in s.
Throws MfInvalidOperationException if not called as static method.
Throws MfArgumentNullException if s is null.
Throws MfFormatException if s is not of the correct format.
Throws MfOverFlowExcpetion s represents a number less than MinValue or greater than MaxValue.
Static method
The s parameter can contain the current culture's MfNumberFormatInfo.PositiveInfinitySymbol, MfNumberFormatInfo.NegativeInfinitySymbol, MfNumberFormatInfo.NaNSymbol, or a string of the form:
[ws][sign][integral-digits[,]]integral-digits[.[fractional-digits]][E[sign]exponential-digits][ws]
Elements in square brackets ([ and ]) are optional. The following table describes each element.
Element |
Description |
ws |
A series of white-space characters. |
sign |
A negative sign symbol (-) or a positive sign symbol (+). Only a leading sign can be used. |
integral-digits |
A series of digits ranging from 0 to 9 that specify the integral part of the number. Runs of integral-digits can be partitioned by a group-separator symbol. For example, in some cultures a comma (,) separates groups of thousands. The integral-digits element can be absent if the string contains the fractional-digits element. |
, |
A culture-specific thousands separator symbol. |
. |
A culture-specific decimal point symbol. |
fractional-digits |
A series of digits ranging from 0 to 9 that specify the fractional part of the number. |
E |
The "e" or "E" character, which indicates that the value is represented in exponential (scientific) notation. |
exponential-digits |
A series of digits ranging from 0 to 9 that specify an exponent. |
The s parameter is interpreted using a combination of the MfNumberStyles.Float and MfNumberStyles.AllowThousands flags. This means that white space and thousands separators are allowed, for example, while currency symbols are not.
For finer control over which style elements are permitted in s for the parse operation to succeed, call the MfFloat.Parse(s, styles) or the MfFloat.Parse(s, style, provider) method.
The s parameter is interpreted using the formatting information in a MfNumberFormatInfo object that is initialized for the current thread culture. For more information, see CurrentInfo. To parse a string using the formatting information of some other culture, call the MfFloat.Parse(s, provider) or MfFloat.Parse(s, style, provider) method.
Ordinarily, if you pass the MfFloat.Parse method a string that is created by calling the MfFloat.ToString method, the original Float value is returned. However, because of a loss of precision, the values may not be equal. In addition, attempting to parse the string representation of either MinValue or MaxValue results in NegativeInfinity and PostiveInfinity as the following example illustrates.
value := MfFloat.MinValue
wf := Mfunc.SetFormat(MfSetFormatNumberType.Instance.FloatFast, "0.16e")
result := value + 0.0
sb := new MfText.StringBuilder()
sb.AppendFormat("MinValue: {0}", result)
sb.AppendLine()
try
{
sb.AppendFormat("ParseResult: {0}", MfFloat.Parse(value))
sb.AppendLine()
}
catch e
{
sb.AppendLine()
sb.Append(e.ToString())
}
value := MfFloat.MaxValue
result := value + 0.0
sb.AppendFormat("MaxValue: {0}", result)
sb.AppendLine()
try
{
sb.AppendFormat("ParseResult: {0}", MfFloat.Parse(value))
}
catch e
{
sb.AppendLine()
sb.Append(e.ToString())
}
Mfunc.SetFormat(MfSetFormatNumberType.Instance.FloatFast, wf)
MsgBox % sb.ToString()
/*
MinValue: -1.7976931348623157e+308
ParseResult: -Infinity
MaxValue: 1.7976931348623157e+308
ParseResult: Infinity
*/
If a separator is encountered in the s parameter during a parse operation, and the applicable currency or number decimal and group separators are the same, the parse operation assumes that the separator is a decimal separator rather than a group separator. For more information about separators, see CurrencyDecimalSeparator, NumberDecimalSeparator, CurrencyGroupSeparator, and NumberGroupSeparator.
The following example illustrates the use of the Parse(String) method.
class Temperature extends MfObject
{
m_value := new MfFloat(0.0, true,, 0.2)
; Parses the temperature from a string in form
; [ws][sign]digits['F|'C][ws]
Parse(s) {
this.VerifyIsNotInstance(A_ThisFunc, A_LineFile, A_LineNumber, A_ThisFunc)
temp := new Temperature()
str := new MfString(s, true)
if (str.TrimEnd().EndsWith("'F"))
{
temp.Value := MfFloat.Parse( str.Remove(str.LastIndexOf("'"), 2) ).Value
}
else if ( str.TrimEnd().EndsWith("'C") )
{
temp.Celsius := MfFloat.Parse( str.Remove(str.LastIndexOf("'"), 2) ).Value
}
else
{
temp.Value := MfFloat.Parse(str)
}
return temp
}
Value[]
{
get {
return this.m_Value.Value
}
set {
this.m_Value.Value := MfFloat.GetValue(value)
}
}
Celsius[]
{
get {
flt := new MfFloat(this.m_Value, true,, this.m_Value.Format)
flt.Subtract(32.0).Divide(1.8)
return flt.GetTrimmed().Value
}
set {
this.m_value.Value := MfFloat.GetValue(value)
this.m_value.Multiply(1.8).Add(32.0)
}
}
ToString() {
return this.m_Value.GetTrimmed().Value . "'F"
}
}
Converts the s representation of a number to its MfFloat equivalent
s
An string var of object convert.
Can be var or instance of MfChar, MfString
style
MfNumberStyles Instance or Integer var representing instance.
A bitwise combination of MfNumberStyles values that indicates the style elements that can be present in s. A typical value to specify is MfNumberStyles.Float. with MfNumberStyles.AllowThousands.
Returns MfFloat instance equivalent to the number contained in s.
Throws MfInvalidOperationException if not called as static method.
Throws MfArgumentNullException if s is null.
Throws MfFormatException if s is not of the correct format.
Throws MfOverFlowExcpetion s represents a number less than MinValue or greater than MaxValue.
Throws MfArgumentException style is not a value.
-or-
style is includes MfNumberStyles.AllowHexSpecifier value.
Version 0.4
Static method
The style parameter defines the style elements (such as white space, thousands separators, and currency symbols) that are allowed in the s parameter for the parse operation to succeed. It must be a combination of bit flags from the MfNumberStyles enumeration. The following MfNumberStyles members are not supported:
The s parameter can contain the current culture's MfNumberFormatInfo.PositiveInfinitySymbol, MfNumberFormatInfo.NegativeInfinitySymbol, or MfNumberFormatInfo.NaNSymbol. Depending on the value of style, it can also take the form:
[ws][$][sign][integral-digits[,]]integral-digits[.[fractional-digits]][E[sign]exponential-digits][ws]
Elements in square brackets ([ and ]) are optional. The following table describes each element.
Element |
Description |
ws |
A series of white-space characters. White space can appear at the beginning of s if style includes the MfNumberStyles.AllowLeadingWhite flag, and it can appear at the end of s if style includes the MFNumberStyles.AllowTrailingWhite flag. |
$ |
A culture-specific currency symbol. Its position in the string is defined by the MfNumberFormatInfo.CurrencyNegativePattern and MfNumberFormatInfo.CurrencyPositivePattern properties of the current culture. The current culture's currency symbol can appear in s if style includes the MfNumberStyles.AllowCurrencySymbol flag. |
sign |
A negative sign symbol (-) or a positive sign symbol (+). The sign can appear at the beginning of s if style includes the MFNumberStyles.AllowLeadingSign flag, and it can appear at the end of s if style includes the MFNumberStyles.AllowTrailingSign flag. Parentheses can be used in s to indicate a negative value if style includes the MfNumberStyles.AllowParentheses flag. |
integral-digits |
A series of digits ranging from 0 to 9 that specify the integral part of the number. The integral-digits element can be absent if the string contains the fractional-digits element. |
, |
A culture-specific group separator. The current culture's group separator symbol can appear in s if style includes the MfNumberStyles.AllowThousands flag |
. |
A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the MFNumberStyles.AllowDecimalPoint flag. |
fractional-digits |
A series of digits ranging from 0 to 9 that specify the fractional part of the number. Fractional digits can appear in s if style includes the MfNumberStyles.AllowDecimalPoint flag. |
E |
The "e" or "E" character, which indicates that the value is represented in exponential (scientific) notation. The s parameter can represent a number in exponential notation if style includes the MfNumberStyles.AllowExponent flag. |
exponential-digits |
A series of digits ranging from 0 to 9 that specify an exponent. |
A string with digits only (which corresponds to the MfNumberStyles.None style) always parses successfully. The remaining MfNumberStyles members control elements that may be present, but are not required to be present, in the input string. The following table indicates how individual MfNumberStyles flags affect the elements that may be present in s.
NumberStyles value |
Elements permitted in s in addition to digits |
The integral-digits element only. |
|
The decimal point (.) and fractional-digits elements. |
|
The "e" or "E" character, which indicates exponential notation. This flag by itself supports values in the form digitsEdigits; additional flags are needed to successfully parse strings with such elements as positive or negative signs and decimal point symbols. |
|
The ws element at the beginning of s. |
|
The ws element at the end of s. |
|
The sign element at the beginning of s. |
|
The sign element at the end of s. |
|
The sign element in the form of parentheses enclosing the numeric value. |
|
The thousands separator (,) element. |
|
The currency ($) element. |
|
All elements. However, s cannot represent a hexadecimal number or a number in exponential notation. |
|
The ws element at the beginning or end of s, sign at the beginning of s, and the decimal point (.) symbol. The s parameter can also use exponential notation. |
|
The ws, sign, thousands separator (,) and decimal point (.) elements. |
|
All elements. However, s cannot represent a hexadecimal number. |
The s parameter is parsed using the formatting information in a MfNumberFormatInfo object that is initialized for the current system culture. For more information, see CurrentInfo.
Ordinarily, if you pass the MfFloat.Parse method a string that is created by calling the MfFloat.ToString method, the original Float value is returned. However, because of a loss of precision, the values may not be equal. In addition, attempting to parse the string representation of either MinValue or MaxValue results in NegativeInfinity and PostiveInfinity as the following example illustrates.
value := MfFloat.MinValue
wf := Mfunc.SetFormat(MfSetFormatNumberType.Instance.FloatFast, "0.16e")
result := value + 0.0
sb := new MfText.StringBuilder()
sb.AppendFormat("MinValue: {0}", result)
sb.AppendLine()
try
{
sb.AppendFormat("ParseResult: {0}", MfFloat.Parse(value))
sb.AppendLine()
}
catch e
{
sb.AppendLine()
sb.Append(e.ToString())
}
value := MfFloat.MaxValue
result := value + 0.0
sb.AppendFormat("MaxValue: {0}", result)
sb.AppendLine()
try
{
sb.AppendFormat("ParseResult: {0}", MfFloat.Parse(value))
}
catch e
{
sb.AppendLine()
sb.Append(e.ToString())
}
Mfunc.SetFormat(MfSetFormatNumberType.Instance.FloatFast, wf)
MsgBox % sb.ToString()
/*
MinValue: -1.7976931348623157e+308
ParseResult: -Infinity
MaxValue: 1.7976931348623157e+308
ParseResult: Infinity
*/
Converts the s representation of a number to its MfFloat equivalent
s
An string var of object convert.
Can be var or instance of MfChar, MfString
provider
An object that supplies culture-specific parsing information about s. If provider is null, then MfNumberFormatInfo is used.
Throws MfInvalidOperationException if not called as static method.
Throws MfArgumentNullException if s is null.
Throws MfFormatException if s is not of the correct format.
Throws MfOverFlowExcpetion s represents a number less than MinValue or greater than MaxValue.
Returns MfFloat instance equivalent to the number contained in s.
Version 0.4
Static method
This overload of the Parse(s, provider) method is typically used to convert text that can be formatted in a variety of ways to a MfFloat value. For example, it can be used to convert the text that is entered by a user into an input text box to a numeric value.
The s parameter can contain the current culture's MfNumberFormatInfo.PositiveInfinitySymbol, MfNumberFormatInfo.NegativeInfinitySymbol, MfNumberFormatInfo.NaNSymbol, or a string of the form:
[ws][sign][integral-digits[,]]integral-digits[.[fractional-digits]][E[sign]exponential-digits][ws]
Elements in square brackets ([ and ]) are optional. The following table describes each element.
Element |
Description |
ws |
A series of white-space characters. |
sign |
A negative sign symbol (-) or a positive sign symbol (+). Only a leading sign can be used. |
integral-digits |
A series of digits ranging from 0 to 9 that specify the integral part of the number. Runs of integral-digits can be partitioned by a group-separator symbol. For example, in some cultures a comma (,) separates groups of thousands. The integral-digits element can be absent if the string contains the fractional-digits element. |
, |
A culture-specific thousands separator symbol. |
. |
A culture-specific decimal point symbol. |
fractional-digits |
A series of digits ranging from 0 to 9 that specify the fractional part of the number. |
E |
The "e" or "E" character, which indicates that the value is represented in exponential (scientific) notation. |
exponential-digits |
A series of digits ranging from 0 to 9 that specify an exponent. |
The s parameter is interpreted using a combination of the MfNumberStyles.Float and MfNumberStyles.AllowThousands flags. This means that white space and thousands separators are allowed, for example, while currency symbols are not.
The provider parameter is an MfFormatProvider implementation whose GetFormat method returns a MfNumberFormatInfo object that supplies culture-specific information used in interpreting the format of s. Typically, it is a MfNumberFormatInfo or CultureInfo object. If provider is null or a MfNumberFormatInfo cannot be obtained, the formatting information for the current system culture is used.
Converts the s representation of a number to its MfFloat equivalent
s
An string var of object convert.
Can be var or instance of MfChar, MfString
style
MfNumberStyles Instance or Integer var representing instance.
A bitwise combination of MfNumberStyles values that indicates the style elements that can be present in s. A typical value to specify is MfNumberStyles.Integer.
provider
An object that supplies culture-specific parsing information about s. If provider is null, then MfNumberFormatInfo is used.
Returns MfFloat instance equivalent to the number contained in s.
Version 0.4
Throws MfInvalidOperationException if not called as static method.
Throws MfArgumentNullException if s is null.
Throws MfFormatException if s is not of the correct format.
Throws MfOverFlowExcpetion s represents a number less than MinValue or greater than MaxValue.
Throws MfArgumentException style is not a value.
-or-
style is includes MfNumberStyles.AllowHexSpecifier value.
Static method
The style parameter defines the style elements (such as white space, thousands separators, and currency symbols) that are allowed in the s parameter for the parse operation to succeed. It must be a combination of bit flags from the MfNumberStyles enumeration. The following MfNumberStyles members are not supported:
The s parameter can contain the current culture's MfNumberFormatInfo.PositiveInfinitySymbol, MfNumberFormatInfo.NegativeInfinitySymbol, or MfNumberFormatInfo.NaNSymbol. Depending on the value of style, it can also take the form:
[ws][$][sign][integral-digits[,]]integral-digits[.[fractional-digits]][E[sign]exponential-digits][ws]
Elements in square brackets ([ and ]) are optional. The following table describes each element.
Element |
Description |
ws |
A series of white-space characters. White space can appear at the beginning of s if style includes the MfNumberStyles.AllowLeadingWhite flag, and it can appear at the end of s if style includes the MFNumberStyles.AllowTrailingWhite flag. |
$ |
A culture-specific currency symbol. Its position in the string is defined by the MfNumberFormatInfo.CurrencyNegativePattern and MfNumberFormatInfo.CurrencyPositivePattern properties of the current culture. The current culture's currency symbol can appear in s if style includes the MfNumberStyles.AllowCurrencySymbol flag. |
sign |
A negative sign symbol (-) or a positive sign symbol (+). The sign can appear at the beginning of s if style includes the MFNumberStyles.AllowLeadingSign flag, and it can appear at the end of s if style includes the MFNumberStyles.AllowTrailingSign flag. Parentheses can be used in s to indicate a negative value if style includes the MfNumberStyles.AllowParentheses flag. |
integral-digits |
A series of digits ranging from 0 to 9 that specify the integral part of the number. The integral-digits element can be absent if the string contains the fractional-digits element. |
, |
A culture-specific group separator. The current culture's group separator symbol can appear in s if style includes the MfNumberStyles.AllowThousands flag |
. |
A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the MFNumberStyles.AllowDecimalPoint flag. |
fractional-digits |
A series of digits ranging from 0 to 9 that specify the fractional part of the number. Fractional digits can appear in s if style includes the MfNumberStyles.AllowDecimalPoint flag. |
E |
The "e" or "E" character, which indicates that the value is represented in exponential (scientific) notation. The s parameter can represent a number in exponential notation if style includes the MfNumberStyles.AllowExponent flag. |
exponential-digits |
A series of digits ranging from 0 to 9 that specify an exponent. |
A string with digits only (which corresponds to the MfNumberStyles.None style) always parses successfully. The remaining MfNumberStyles members control elements that may be present, but are not required to be present, in the input string. The following table indicates how individual MfNumberStyles flags affect the elements that may be present in s.
NumberStyles value |
Elements permitted in s in addition to digits |
The integral-digits element only. |
|
The decimal point (.) and fractional-digits elements. |
|
The "e" or "E" character, which indicates exponential notation. This flag by itself supports values in the form digitsEdigits; additional flags are needed to successfully parse strings with such elements as positive or negative signs and decimal point symbols. |
|
The ws element at the beginning of s. |
|
The ws element at the end of s. |
|
The sign element at the beginning of s. |
|
The sign element at the end of s. |
|
The sign element in the form of parentheses enclosing the numeric value. |
|
The thousands separator (,) element. |
|
The currency ($) element. |
|
All elements. However, s cannot represent a hexadecimal number or a number in exponential notation. |
|
The ws element at the beginning or end of s, sign at the beginning of s, and the decimal point (.) symbol. The s parameter can also use exponential notation. |
|
The ws, sign, thousands separator (,) and decimal point (.) elements. |
|
All elements. However, s cannot represent a hexadecimal number. |
The provider parameter is an MfFormatProvider implementation whose GetFormat method returns a MfNumberFormatInfo object that supplies culture-specific information used in interpreting the format of s. Typically, it is a MfNumberFormatInfo or CultureInfo object. If provider is null or a MfNumberFormatInfo cannot be obtained, the formatting information for the current system culture is used.
Ordinarily, if you pass the MfFloat.Parse method a string that is created by calling the MfFloat.ToString method, the original Float value is returned. However, because of a loss of precision, the values may not be equal. In addition, attempting to parse the string representation of either MinValue or MaxValue results in NegativeInfinity and PostiveInfinity as the following example illustrates.
value := MfFloat.MinValue
wf := Mfunc.SetFormat(MfSetFormatNumberType.Instance.FloatFast, "0.16e")
result := value + 0.0
sb := new MfText.StringBuilder()
sb.AppendFormat("MinValue: {0}", result)
sb.AppendLine()
try
{
sb.AppendFormat("ParseResult: {0}", MfFloat.Parse(value))
sb.AppendLine()
}
catch e
{
sb.AppendLine()
sb.Append(e.ToString())
}
value := MfFloat.MaxValue
result := value + 0.0
sb.AppendFormat("MaxValue: {0}", result)
sb.AppendLine()
try
{
sb.AppendFormat("ParseResult: {0}", MfFloat.Parse(value))
}
catch e
{
sb.AppendLine()
sb.Append(e.ToString())
}
Mfunc.SetFormat(MfSetFormatNumberType.Instance.FloatFast, wf)
MsgBox % sb.ToString()
/*
MinValue: -1.7976931348623157e+308
ParseResult: -Infinity
MaxValue: 1.7976931348623157e+308
ParseResult: Infinity
*/