Ingrid Falk > Lingua-FR-Ladl > Lingua::FR::Ladl::Graph

Download:
Lingua-FR-Ladl-v0.0.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Graph - Perl extension for blah blah blah

VERSION ^

This document describes Graph version 0.0.1

SYNOPSIS ^

   use Graph;
   blah blah blah

DESCRIPTION ^

Stub documentation for Graph, created by perlnow.el using template.el.

INTERFACE ^

load
  $lgraph->load( {format => 'dot', file=>'file_name'} )

Load a Ladl graph from a file in the dot format. Currently, this is the only supported graph input format.

is_plausible
 $lgraph->is_plausible()

Checks whether it's plausible that this graph may be a Ladl graph.

NOTE:

It's probably not possible to ultimately check if a given graph may be a Ladl graph. We only verify it doesn't violate some basic properties, which as of now are:

is a directed, acyclic Graph (a DAG)
the source vertices are boxes, i.e. their shape attribute is record.
has no isolated vertices
get_frame_vertices_for

Returns the frame vertices. Frame vertices of a Ladl graph are the source vertices. Called in

list context returns the list of frame vertices,

scalar context returns the number of elements of the list,

string context returns the concatenation of the vertices,

arrayref context return a reference to the list of frame vertices,

void context prints the stringified list.

DIAGNOSTICS ^

Error message here, perhaps with %s placeholders

[Description of error here]

Another error message here

[Description of error here]

[Et cetera, et cetera]

CONFIGURATION AND ENVIRONMENT ^

<MODULE NAME> requires no configuration files or environment variables.

DEPENDENCIES ^

None.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-<RT NAME@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

SEE ALSO ^

Mention other useful documentation such as the documentation of related modules or operating system documentation (such as man pages in UNIX), or any relevant external documentation such as RFCs or standards.

If you have a mailing list set up for your module, mention it here.

If you have a web site set up for your module, mention it here.

AUTHOR ^

Ingrid Falk, <falk@localhost.>

COPYRIGHT AND LICENSE ^

Copyright (C) 2007 by Ingrid Falk

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: