XCLE_Obj

XCLE: eXtensible Concatenative Language Engine
Copyright (C) 2000-2006 Yann LANDRIN-SCHWEITZER a.k.a. Varkhan

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author: Yann LANDRIN-SCHWEITZER
Contact: varkhan@varkhan.net
Homepage: http://www.varkhan.net/

XCLE_Fltp object type

Function XCLE_FltpAlloc

XCLE_Fltp XCLE_FltpAlloc(void) ;
Allocates a new Fltp object with value zero.

Returns:
	_ NULL	: if no memory was available
	else the allocated Fltp, with value zero.

	Errors:
		_ ENOMEM	: if no memory was available

	Note:
		The Fltp object type is a double precision floating point number.

Function XCLE_FltpCopy

XCLE_Fltp XCLE_FltpCopy(XCLE_Fltp fp) ;
Copies a Fltp object.

	Args:
		_ fp	: Fltp object to copy

Returns:
	_ NULL	: if no memory was available
	else a new Fltp object with the same value as 'fp'.

Errors:
	_ EINVAL	: if a NULL was passed as argument
	_ ENOMEM	: if no memory was available

	Note:
		XCLE_FltpCopy and XCLE_FltpClone do exactly the same thing

Function XCLE_FltpClone

XCLE_Fltp XCLE_FltpClone(XCLE_Fltp fp) ;
Clones a Fltp object.

	Args:
		_ fp	: Fltp object to clone

Returns:
	_ NULL	: if no memory was available
	else a new Fltp object with the same value as 'fp'.

Errors:
	_ EINVAL	: if a NULL was passed as argument
	_ ENOMEM	: if no memory was available

	Note:
		XCLE_FltpCopy and XCLE_FltpClone do exactly the same thing

Function XCLE_FltpFree

void XCLE_FltpFree(XCLE_Fltp in) ;
Frees an Fltp object.

	Args:
		_ in	: Fltp object to free

Function XCLE_FltpNew

XCLE_Fltp XCLE_FltpNew(double nb) ;
Creates a new Fltp object from a floating point value.

	Args:
		_ nb	: value to give to the new object

Returns:
	_ NULL	: if no memory was available
	else a new Fltp object with value 'nb'.

Errors:
	_ EINVAL	: if a NULL was passed as argument
	_ ENOMEM	: if no memory was available

Function XCLE_FltpEqual

unsigned char XCLE_FltpEqual(XCLE_Fltp fp, XCLE_Fltp fpw) ;
Compares two Fltp objects.

Args:
	_ fp	: Fltp object to compare
	_ fpw	: reference Fltp object

Returns:
	_ -1	: if a NULL Fltp was passed as argument
	_ 0	: if the two Fltp objects had distinct values
	_ +1	: if the two Fltp objects had the same value

Errors:
	_ EINVAL	: if a NULL was passed as argument
	_ ENOMEM	: if no memory was available

Function XCLE_FltpValue

double XCLE_FltpValue(XCLE_Fltp fp) ;
Retrives the value of a Fltp object.

	Args:
		_ in	: Fltp to query

Returns:
	_ 0	: if a NULL Fltp was passed as argument
	else the floating point value if the Fltp object.

	Errors:
		_ EINVAL	: if a NULL Fltp was passed as argument

Generated by textdoc2html - 2006-02-22