The parse-float Reference Manual

This is the parse-float Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:05:45 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 parse-float

Parse floating point values in strings.

Author

Sumant Oemrawsingh

License

Public Domain

Dependency

alexandria (system).

Source

parse-float.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 parse-float/parse-float.asd

Source

parse-float.asd.

Parent Component

parse-float (system).

ASDF Systems

parse-float.


3.1.2 parse-float/package.lisp

Source

parse-float.asd.

Parent Component

parse-float (system).

Packages

parse-float.


3.1.3 parse-float/parse-float.lisp

Dependency

package.lisp (file).

Source

parse-float.asd.

Parent Component

parse-float (system).

Public Interface

parse-float (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 parse-float

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface

parse-float (function).

Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: parse-float (string &key start end radix junk-allowed decimal-character exponent-character type)

Similar to PARSE-INTEGER, but parses a floating point value and returns the value as the specified TYPE (by default *READ-DEFAULT-FLOAT-FORMAT*). The DECIMAL-CHARACTER (by default #.) specifies the separator between the integer and decimal parts, and the EXPONENT-CHARACTER (by default #e, case insensitive) specifies the character before the exponent. Note that the exponent is only parsed if RADIX is 10.

Package

parse-float.

Source

parse-float.lisp.


5.2 Internals


5.2.1 Constants

Constant: +whitespace-characters+

List of whitespace characters

Package

parse-float.

Source

parse-float.lisp.


5.2.2 Ordinary functions

Function: parse-integer-only (string &key start end radix allow-sign)

Parse an integer from a string, without skipping whitespaces. Returns three values: the integer, the position in the string that ended the parsing, and a boolean which is T if the parsing ended due to a whitespace or end of the string, and NIL otherwise. If allow-sign is NIL (T by default), also signs are not allowed in the string (i.e. cannot start with #+ or #-).

Package

parse-float.

Source

parse-float.lisp.

Function: sign-char-p (character)

Predicate for testing if CHARACTER is a sign character (i.e. #+ or #-).

Package

parse-float.

Source

parse-float.lisp.

Function: skip-whitespaces (string &key start end)

For the substring in STRING delimited by START and END, skip all the whitespace at the beginning and return the index of the first non-whitespace character, or END if no non-whitespace characters were found.

Package

parse-float.

Source

parse-float.lisp.

Function: whitespace-char-p (character)

Predicate for testing if CHARACTER is a whitespace character.

Package

parse-float.

Source

parse-float.lisp.


5.2.3 Types

Type: bounding-index ()

A valid upper bound to a string.

Package

parse-float.

Source

parse-float.lisp.

Type: string-index ()

A valid string index.

Package

parse-float.

Source

parse-float.lisp.

Type: valid-radix ()

A valid Common Lisp radix.

Package

parse-float.

Source

parse-float.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+whitespace-characters+: Private constants

C
Constant, +whitespace-characters+: Private constants