Section 3: library functions
Dpkg::Control::Changelog – represent info fields output by dpkg-parsechangelog DescriptionThis object derives directly from Dpkg::Control with the type CTRL_CHANGELOG. Functions$c = Dpkg::Control::Changelog->new() Create a new empty set of changelog related fields.ChangesVersion 1.00Mark the module as public. AuthorRaphaël Hertzog <hertzog [at] debian.org>.
Dpkg::Control – parse and manipulate official control-like information DescriptionThe Dpkg::Control object is a smart version of Dpkg::Control::Hash. It associates a type to the control information. That type can be used to know what fields are allowed and in what order they must be output. The types are constants that are exported by default. Here’s the…
Dpkg::Conf – parse dpkg configuration files DescriptionThe Dpkg::Conf object can be used to read options from a configuration file. It can exports an array that can then be parsed exactly like @ARGV. Functionsmy $conf = Dpkg::Conf->new(%opts) Create a new Dpkg::Conf object. Some options can be set through %opts: if allow_short evaluates to true (it defaults…
Dpkg::Compression::Process – run compression/decompression processes DescriptionThis module provides an object oriented interface to run and manage compression/decompression processes. Methodsmy $proc = Dpkg::Compression::Process->new(%opts) Create a new instance of the object. Supported options are “compression” and “compression_level” (see corresponding set_* functions). $proc->set_compression($comp) Select the compression method to use. It errors out if the method is not supported…
Dpkg::Compression::FileHandle – object dealing transparently with file compression Synopsis use Dpkg::Compression::FileHandle; $fh = Dpkg::Compression::FileHandle->new(filename => ‘sample.gz’); print $fh "Something\n"; close $fh; $fh = Dpkg::Compression::FileHandle->new(); open($fh, ‘>’, ‘sample.bz2’); print $fh "Something\n"; close $fh; $fh = Dpkg::Compression::FileHandle->new(); $fh->open(‘sample.xz’, ‘w’); $fh->print("Something\n"); $fh->close(); $fh = Dpkg::Compression::FileHandle->new(filename => ‘sample.gz’); my @lines = <$fh>; close $fh; $fh = Dpkg::Compression::FileHandle->new(); open($fh, ‘<‘,…
Dpkg::Compression – simple database of available compression methods DescriptionThis modules provides a few public funcions and a public regex to interact with the set of supported compression methods. Functionsmy @list = compression_get_list() Returns a list of supported compression methods (sorted alphabetically). compression_is_supported($comp) Returns a boolean indicating whether the give compression method is known and supported….
Dpkg::Checksums – generate and manipulate file checksums DescriptionThis module provides an object that can generate and manipulate various file checksums as well as some methods to query information about supported checksums. Functions@list = checksums_get_list() Returns the list of supported checksums algorithms. $bool = checksums_is_supported($alg) Returns a boolean indicating whether the given checksum algorithm is supported….
Dpkg::Changelog::Parse – generic changelog parser for dpkg-parsechangelog DescriptionThis module provides a single function changelog_parse() which reproduces all the features of dpkg-parsechangelog. FUNCTIONSmy $fields = changelog_parse(%opt) This function will parse a changelog. In list context, it return as many Dpkg::Control object as the parser did output. In scalar context, it will return only the first one….
Dpkg::Changelog::Entry::Debian – represents a Debian changelog entry DescriptionThis object represents a Debian changelog entry. It implements the generic interface Dpkg::Changelog::Entry. Only functions specific to this implementation are described below. Functionsmy @items = $entry->get_change_items() Return a list of change items. Each item contains at least one line. A change line starting with an asterisk denotes the…
Dpkg::Changelog::Entry – represents a changelog entry DescriptionThis object represents a changelog entry. It is composed of a set of lines with specific purpose: an header line, changes lines, a trailer line. Blank lines can be between those kind of lines. Functionsmy $entry = Dpkg::Changelog::Entry->new() Creates a new object. It doesn’t represent a real changelog entry…
Dpkg::Changelog::Debian – parse Debian changelogs DescriptionDpkg::Changelog::Debian parses Debian changelogs as described in the Debian policy (version 3.6.2.1 at the time of this writing). See section “SEE ALSO” for locations where to find this definition. The parser tries to ignore most cruft like # or /* */ style comments, CVS comments, vim variables, emacs local variables…
Dpkg::Changelog – base class to implement a changelog parser DescriptionDpkg::Changelog is a class representing a changelog file as an array of changelog entries (Dpkg::Changelog::Entry). By deriving this object and implementing its parse method, you add the ability to fill this object with changelog entries. FUNCTIONSmy $c = Dpkg::Changelog->new(%options) Creates a new changelog object. $c->load($filename) Parse…
Dpkg::BuildProfiles – handle build profiles DescriptionThe Dpkg::BuildProfiles module provides functions to handle the build profiles. Functionsmy @profiles = get_build_profiles() Get an array with the currently active build profiles, taken from the environment variable DEB_BUILD_PROFILES. set_build_profiles(@profiles) Set @profiles as the current active build profiles, by setting the environment variable DEB_BUILD_PROFILES. my @profiles = parse_build_profiles($string) Parses a…
Dpkg::BuildOptions – parse and update build options DescriptionThe Dpkg::BuildOptions object can be used to manipulate options stored in environment variables like DEB_BUILD_OPTIONS and DEB_BUILD_MAINT_OPTIONS. Functionsmy $bo = Dpkg::BuildOptions->new(%opts) Create a new Dpkg::BuildOptions object. It will be initialized based on the value of the environment variable named $opts{envvar} (or DEB_BUILD_OPTIONS if that option is not set)….
Dpkg::BuildFlags – query build flags DescriptionThe Dpkg::BuildFlags object is used by dpkg-buildflags and can be used to query the same information. Functionsmy $bf = Dpkg::BuildFlags->new() Create a new Dpkg::BuildFlags object. It will be initialized based on the value of several configuration files and environment variables. $bf->load_vendor_defaults() Reset the flags stored to the default set provided…
Dpkg::BuildEnv – track build environment DescriptionThe Dpkg::BuildEnv module is used by dpkg-buildflags to track the build environment variables being used and modified. Functions$bf->set($varname, $value) Update the build environment variable $varname with value $value. Record it as being accessed and modified. $bf->get($varname) Get the build environment variable $varname value. Record it as being accessed. $bf->has($varname) Return…
Dpkg – module with core variables DescriptionThe Dpkg module provides a set of variables with information concerning this system installation. Variables$Dpkg::PROGNAME Contains the name of the current program. $Dpkg::PROGVERSION Contains the version of the dpkg suite. $Dpkg::CONFDIR Contains the path to the dpkg system configuration directory. $Dpkg::ADMINDIR Contains the path to the dpkg database directory….
QuantLib::Rounding – basic rounding class Synopsis#include <ql/math/rounding.hpp> Inherited by CeilingTruncation, ClosestRounding, DownRounding, FloorTruncation, and UpRounding. Public Typesenum Type { None, Up, Down, Closest, Floor, Ceiling } rounding methods Public Member FunctionsRounding () default constructor Rounding (Integer precision, Type type=Closest, Integer digit=5) Decimal operator() (Decimal value) const perform rounding InspectorsInteger precision () const Type type ()…
QuantLib::DoubleStickyRatchetPayoff – Intermediate class for single/double sticky/ratchet payoffs. Synopsis#include <ql/instruments/stickyratchet.hpp> Inherits QuantLib::Payoff. Inherited by RatchetMaxPayoff, RatchetMinPayoff, RatchetPayoff, StickyMaxPayoff, StickyMinPayoff, and StickyPayoff. Public Member FunctionsDoubleStickyRatchetPayoff (Real type1, Real type2, Real gearing1, Real gearing2, Real gearing3, Real spread1, Real spread2, Real spread3, Real initialValue1, Real initialValue2, Real accrualFactor) Payoff interface std::string name () const Real operator() (Real…
QuantLib::Array – 1-D array used in linear algebra. Synopsis#include <ql/math/array.hpp> Public Typestypedef Real value_type typedef Real * iterator typedef const Real * const_iterator typedef boost::reverse_iterator< iterator > reverse_iterator typedef boost::reverse_iterator< const_iterator > const_reverse_iterator Public Member FunctionsConstructors, destructor, and assignment Array (Size size=0) creates the array with the given dimension Array (Size size, Real value) creates…