mpfr_lib.mpfr_vasprintf Method (char

mpfr_libmpfr_vasprintf Method (char_ptr, String, Object)

Write output as a null terminated string in a block of memory allocated using the allocation function (see GNU MPFR - Memory Handling).

Namespace: Math.Mpfr.Native
Assembly: Math.Mpfr.Native (in Math.Mpfr.Native.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public static int mpfr_vasprintf(
	ref char_ptr str,
	string template,
	params Object[] arguments
)

Public Shared Function mpfr_vasprintf ( 
	ByRef str As char_ptr,
	template As String,
	ParamArray arguments As Object()
) As Integer

public:
static int mpfr_vasprintf(
	char_ptr% str, 
	String^ template, 
	... array<Object^>^ arguments
)

static member mpfr_vasprintf : 
        str : char_ptr byref * 
        template : string * 
        arguments : Object[] -> int

Parameters

str: Type: Math.Gmp.Nativechar_ptr
The output string.
template: Type: SystemString
Format string. See Formatted Output Functions.
arguments: Type: SystemObject
Arguments.

Return Value

Type: Int32
The return value is the number of characters written in the string, excluding the null-terminator, or a negative value if an error occurred, in which case the contents of str are undefined.

Remarks

A pointer to the block is stored in str. The block of memory must be freed using mpfr_free_str.

Examples

C++

Copy

char_ptr str = new char_ptr();

mpfr_t r = "12345e6";
Assert.IsTrue(mpfr_lib.mpfr_vasprintf(ref str, "%Re", r) == 10);
Assert.IsTrue(str.ToString() == "1.2345e+10");
gmp_lib.free(str);
Assert.IsTrue(mpfr_lib.mpfr_vasprintf(ref str, "%Rf", r) == 18);
Assert.IsTrue(str.ToString() == "12345000000.000000");
gmp_lib.free(str);
Assert.IsTrue(mpfr_lib.mpfr_vasprintf(ref str, "%Rg", r) == 10);
Assert.IsTrue(str.ToString() == "1.2345e+10");
gmp_lib.free(str);
Assert.IsTrue(mpfr_lib.mpfr_vasprintf(ref str, "%Ra", r) == 15);
Assert.IsTrue(str.ToString() == "0x2.dfd1c04p+32");
gmp_lib.free(str);
mpfr_lib.mpfr_clear(r);

Dim str As char_ptr = New char_ptr()

Dim r As mpfr_t = "12345e6"
Assert.IsTrue(mpfr_lib.mpfr_vasprintf( str,"%Re",r)  =  10)
Assert.IsTrue(str.ToString() = "1.2345e+10")
gmp_lib.free(str)
Assert.IsTrue(mpfr_lib.mpfr_vasprintf( str,"%Rf",r)  =  18)
Assert.IsTrue(str.ToString() = "12345000000.000000")
gmp_lib.free(str)
Assert.IsTrue(mpfr_lib.mpfr_vasprintf( str,"%Rg",r)  =  10)
Assert.IsTrue(str.ToString() = "1.2345e+10")
gmp_lib.free(str)
Assert.IsTrue(mpfr_lib.mpfr_vasprintf( str,"%Ra",r)  =  15)
Assert.IsTrue(str.ToString() = "0x2.dfd1c04p+32")
gmp_lib.free(str)
mpfr_lib.mpfr_clear(r)

Reference

mpfr_lib Class

mpfr_vasprintf Overload

Math.Mpfr.Native Namespace

mpfr_vasprintf(ptr{char_ptr}, string, object[])

Formatted Output Functions

GNU MPFR - Formatted Output Functions