mirror of
https://github.com/dlang/phobos.git
synced 2025-04-27 21:51:40 +03:00
Ensure each module has a description at the top.
This commit is contained in:
parent
6dcabe9ba4
commit
a13cee766d
12 changed files with 41 additions and 42 deletions
|
@ -1,6 +1,11 @@
|
||||||
// Written in the D programming language.
|
// Written in the D programming language.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
Implements algorithms oriented mainly towards processing of
|
||||||
|
sequences. Sequences processed by these functions define range-based interfaces.
|
||||||
|
See also $(LINK2 std_range.html, Reference on ranges) and
|
||||||
|
$(WEB ddili.org/ders/d.en/ranges.html, tutorial on ranges).
|
||||||
|
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -43,15 +48,6 @@ $(MYREF stripRight) $(MYREF swap) $(MYREF swapRanges) $(MYREF uninitializedFill)
|
||||||
$(TR $(TDNW Utility) $(TD $(MYREF forward) ))
|
$(TR $(TDNW Utility) $(TD $(MYREF forward) ))
|
||||||
)
|
)
|
||||||
|
|
||||||
Implements algorithms oriented mainly towards processing of
|
|
||||||
sequences. Some functions are semantic equivalents or supersets of
|
|
||||||
those found in the $(D $(LESS)_algorithm$(GREATER)) header in $(WEB
|
|
||||||
sgi.com/tech/stl/, Alexander Stepanov's Standard Template Library) for
|
|
||||||
C++. Sequences processed by these functions define range-based interfaces.
|
|
||||||
|
|
||||||
$(LINK2 std_range.html, Reference on ranges)$(BR)
|
|
||||||
$(LINK2 http://ddili.org/ders/d.en/ranges.html, Tutorial on ranges)
|
|
||||||
|
|
||||||
Many functions in this module are parameterized with a function or a
|
Many functions in this module are parameterized with a function or a
|
||||||
$(GLOSSARY predicate). The predicate may be passed either as a
|
$(GLOSSARY predicate). The predicate may be passed either as a
|
||||||
function name, a delegate name, a $(GLOSSARY functor) name, or a
|
function name, a delegate name, a $(GLOSSARY functor) name, or a
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
/**
|
/**
|
||||||
|
Cyclic Redundancy Check (32-bit) implementation.
|
||||||
|
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -13,7 +15,6 @@ $(TR $(TDNW Helpers) $(TD $(MYREF crcHexString) $(MYREF crc32Of))
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
* Cyclic Redundancy Check (32-bit) implementation.
|
|
||||||
*
|
*
|
||||||
* This module conforms to the APIs defined in $(D std.digest.digest). To understand the
|
* This module conforms to the APIs defined in $(D std.digest.digest). To understand the
|
||||||
* differences between the template and the OOP API, see $(D std.digest.digest).
|
* differences between the template and the OOP API, see $(D std.digest.digest).
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
/**
|
/**
|
||||||
|
* This module describes the digest APIs used in Phobos. All digests follow these APIs.
|
||||||
|
* Additionally, this module contains useful helper methods which can be used with every _digest type.
|
||||||
|
*
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -17,9 +20,6 @@ $(TR $(TDNW Implementation helpers) $(TD $(MYREF digestLength) $(MYREF WrapperDi
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
* This module describes the digest APIs used in Phobos. All digests follow these APIs.
|
|
||||||
* Additionally, this module contains useful helper methods which can be used with every _digest type.
|
|
||||||
*
|
|
||||||
* APIs:
|
* APIs:
|
||||||
* There are two APIs for digests: The template API and the OOP API. The template API uses structs
|
* There are two APIs for digests: The template API and the OOP API. The template API uses structs
|
||||||
* and template helpers like $(LREF isDigest). The OOP API implements digests as classes inheriting
|
* and template helpers like $(LREF isDigest). The OOP API implements digests as classes inheriting
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
/**
|
/**
|
||||||
|
* Computes MD5 hashes of arbitrary data. MD5 hashes are 16 byte quantities that are like a
|
||||||
|
* checksum or CRC, but are more robust.
|
||||||
|
*
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -13,9 +16,6 @@ $(TR $(TDNW Helpers) $(TD $(MYREF md5Of))
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
* Computes MD5 hashes of arbitrary data. MD5 hashes are 16 byte quantities that are like a
|
|
||||||
* checksum or CRC, but are more robust.
|
|
||||||
*
|
|
||||||
* This module conforms to the APIs defined in $(D std.digest.digest). To understand the
|
* This module conforms to the APIs defined in $(D std.digest.digest). To understand the
|
||||||
* differences between the template and the OOP API, see $(D std.digest.digest).
|
* differences between the template and the OOP API, see $(D std.digest.digest).
|
||||||
*
|
*
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
/**
|
/**
|
||||||
|
* Computes RIPEMD-160 hashes of arbitrary data. RIPEMD-160 hashes are 20 byte quantities
|
||||||
|
* that are like a checksum or CRC, but are more robust.
|
||||||
|
*
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -13,9 +16,6 @@ $(TR $(TDNW Helpers) $(TD $(MYREF ripemd160Of))
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
* Computes RIPEMD-160 hashes of arbitrary data. RIPEMD-160 hashes are 20 byte quantities
|
|
||||||
* that are like a checksum or CRC, but are more robust.
|
|
||||||
*
|
|
||||||
* This module conforms to the APIs defined in $(D std.digest.digest). To understand the
|
* This module conforms to the APIs defined in $(D std.digest.digest). To understand the
|
||||||
* differences between the template and the OOP API, see $(D std.digest.digest).
|
* differences between the template and the OOP API, see $(D std.digest.digest).
|
||||||
*
|
*
|
||||||
|
|
|
@ -1,5 +1,9 @@
|
||||||
// Written in the D programming language.
|
// Written in the D programming language.
|
||||||
/**
|
/**
|
||||||
|
* Computes SHA1 and SHA2 hashes of arbitrary data. SHA hashes are 20 to 64 byte
|
||||||
|
* quantities (depending on the SHA algorithm) that are like a checksum or CRC,
|
||||||
|
* but are more robust.
|
||||||
|
*
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -14,10 +18,6 @@ $(TR $(TDNW Helpers) $(TD $(MYREF sha1Of))
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
* Computes SHA1 and SHA2 hashes of arbitrary data. SHA hashes are 20 to 64 byte
|
|
||||||
* quantities (depending on the SHA algorithm) that are like a checksum or CRC,
|
|
||||||
* but are more robust.
|
|
||||||
*
|
|
||||||
* SHA2 comes in several different versions, all supported by this module:
|
* SHA2 comes in several different versions, all supported by this module:
|
||||||
* SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224 and SHA-512/256.
|
* SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224 and SHA-512/256.
|
||||||
*
|
*
|
||||||
|
|
11
std/math.d
11
std/math.d
|
@ -1,6 +1,10 @@
|
||||||
// Written in the D programming language.
|
// Written in the D programming language.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Contains the elementary mathematical functions (powers, roots,
|
||||||
|
* and trigonometric functions), and low-level floating-point operations.
|
||||||
|
* Mathematical special functions are available in $(D std.mathspecial).
|
||||||
|
*
|
||||||
$(SCRIPT inhibitQuickIndex = 1;)
|
$(SCRIPT inhibitQuickIndex = 1;)
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -50,13 +54,6 @@ $(TR $(TDNW Hardware Control) $(TD
|
||||||
))
|
))
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
* Elementary mathematical functions
|
|
||||||
*
|
|
||||||
* Contains the elementary mathematical functions (powers, roots,
|
|
||||||
* and trigonometric functions), and low-level floating-point operations.
|
|
||||||
* Mathematical special functions are available in std.mathspecial.
|
|
||||||
*
|
|
||||||
* The functionality closely follows the IEEE754-2008 standard for
|
* The functionality closely follows the IEEE754-2008 standard for
|
||||||
* floating-point arithmetic, including the use of camelCase names rather
|
* floating-point arithmetic, including the use of camelCase names rather
|
||||||
* than C99-style lower case names. All of these functions behave correctly
|
* than C99-style lower case names. All of these functions behave correctly
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
// Written in the D programming language.
|
// Written in the D programming language.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
Networking client functionality as provided by $(WEB _curl.haxx.se/libcurl,
|
||||||
|
libcurl). The libcurl library must be installed on the system in order to use
|
||||||
|
this module.
|
||||||
|
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -16,10 +20,6 @@ SMTP) )
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
Networking client functionality as provided by $(WEB _curl.haxx.se/libcurl,
|
|
||||||
libcurl). The libcurl library must be installed on the system in order to use
|
|
||||||
this module.
|
|
||||||
|
|
||||||
Windows x86 note:
|
Windows x86 note:
|
||||||
A DMD compatible libcurl static library can be downloaded from the dlang.org
|
A DMD compatible libcurl static library can be downloaded from the dlang.org
|
||||||
$(LINK2 http://dlang.org/download.html, download page).
|
$(LINK2 http://dlang.org/download.html, download page).
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
// Written in the D programming language.
|
// Written in the D programming language.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
Serialize data to $(D ubyte) arrays.
|
||||||
|
|
||||||
* Macros:
|
* Macros:
|
||||||
* WIKI = Phobos/StdOutbuffer
|
* WIKI = Phobos/StdOutbuffer
|
||||||
*
|
*
|
||||||
|
|
|
@ -34,6 +34,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Socket primitives.
|
||||||
* Example: See $(SAMPLESRC listener.d) and $(SAMPLESRC htmlget.d)
|
* Example: See $(SAMPLESRC listener.d) and $(SAMPLESRC htmlget.d)
|
||||||
* License: $(WEB www.boost.org/LICENSE_1_0.txt, Boost License 1.0).
|
* License: $(WEB www.boost.org/LICENSE_1_0.txt, Boost License 1.0).
|
||||||
* Authors: Christopher E. Miller, $(WEB klickverbot.at, David Nadlinger),
|
* Authors: Christopher E. Miller, $(WEB klickverbot.at, David Nadlinger),
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
// Written in the D programming language.
|
// Written in the D programming language.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
String handling functions. Note that many typical string functions are found in
|
||||||
|
$(D std.algorithm) because all D strings are bidirectional ranges.
|
||||||
|
|
||||||
$(SCRIPT inhibitQuickIndex = 1;)
|
$(SCRIPT inhibitQuickIndex = 1;)
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -51,7 +54,6 @@ $(TR $(TDNW Miscellaneous)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
This module presents String handling functions.
|
|
||||||
Objects of types $(D _string), $(D wstring), and $(D dstring) are value types
|
Objects of types $(D _string), $(D wstring), and $(D dstring) are value types
|
||||||
and cannot be mutated element-by-element. For using mutation during building
|
and cannot be mutated element-by-element. For using mutation during building
|
||||||
strings, use $(D char[]), $(D wchar[]), or $(D dchar[]). The $(D xxxstring)
|
strings, use $(D char[]), $(D wchar[]), or $(D dchar[]). The $(D xxxstring)
|
||||||
|
|
14
std/uuid.d
14
std/uuid.d
|
@ -1,4 +1,11 @@
|
||||||
/**
|
/**
|
||||||
|
* A $(LINK2 http://en.wikipedia.org/wiki/Universally_unique_identifier, UUID), or
|
||||||
|
* $(LINK2 http://en.wikipedia.org/wiki/Universally_unique_identifier, Universally unique identifier),
|
||||||
|
* is intended to uniquely identify information in a distributed environment
|
||||||
|
* without significant central coordination. It can be
|
||||||
|
* used to tag objects with very short lifetimes, or to reliably identify very
|
||||||
|
* persistent objects across a network.
|
||||||
|
*
|
||||||
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
<script type="text/javascript">inhibitQuickIndex = 1</script>
|
||||||
|
|
||||||
$(BOOKTABLE ,
|
$(BOOKTABLE ,
|
||||||
|
@ -19,13 +26,6 @@ $(MYREF oidNamespace) $(MYREF x500Namespace) )
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
* A $(LINK2 http://en.wikipedia.org/wiki/Universally_unique_identifier, UUID), or
|
|
||||||
* $(LINK2 http://en.wikipedia.org/wiki/Universally_unique_identifier, Universally unique identifier),
|
|
||||||
* is intended to uniquely identify information in a distributed environment
|
|
||||||
* without significant central coordination. It can be
|
|
||||||
* used to tag objects with very short lifetimes, or to reliably identify very
|
|
||||||
* persistent objects across a network.
|
|
||||||
*
|
|
||||||
* UUIDs have many applications. Some examples follow: Databases may use UUIDs to identify
|
* UUIDs have many applications. Some examples follow: Databases may use UUIDs to identify
|
||||||
* rows or records in order to ensure that they are unique across different
|
* rows or records in order to ensure that they are unique across different
|
||||||
* databases, or for publication/subscription services. Network messages may be
|
* databases, or for publication/subscription services. Network messages may be
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue