.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Attean::API::Plan 3pm"
.TH Attean::API::Plan 3pm "2016-06-11" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Attean::API::Plan \- Query plan
.SH "VERSION"
.IX Header "VERSION"
This document describes Attean::API::Plan version 0.017
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Attean::API::Plan role defines a common \s-1API\s0 for all query plans.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .IP """cost""" 4
.el .IP "\f(CWcost\fR" 4
.IX Item "cost"
.PD 0
.ie n .IP """distinct""" 4
.el .IP "\f(CWdistinct\fR" 4
.IX Item "distinct"
.ie n .IP """item_type""" 4
.el .IP "\f(CWitem_type\fR" 4
.IX Item "item_type"
.ie n .IP """in_scope_variables""" 4
.el .IP "\f(CWin_scope_variables\fR" 4
.IX Item "in_scope_variables"
.ie n .IP """ordered""" 4
.el .IP "\f(CWordered\fR" 4
.IX Item "ordered"
.PD
.SH "REQUIRED METHODS"
.IX Header "REQUIRED METHODS"
The following methods are required by the Attean::API::Plan role:
.ie n .IP """impl( $model )""" 4
.el .IP "\f(CWimpl( $model )\fR" 4
.IX Item "impl( $model )"
Returns a code reference that when called (without arguments), returns an
Attean::API::Iterator object.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """has_cost""" 4
.el .IP "\f(CWhas_cost\fR" 4
.IX Item "has_cost"
.PD 0
.ie n .IP """as_string""" 4
.el .IP "\f(CWas_string\fR" 4
.IX Item "as_string"
.PD
Returns a tree-structured string representation of this plan, including children.
.ie n .IP """evaluate( $model )""" 4
.el .IP "\f(CWevaluate( $model )\fR" 4
.IX Item "evaluate( $model )"
Evaluates this plan and returns the resulting iterator.
.ie n .IP """in_scope_variables_union( @plans )""" 4
.el .IP "\f(CWin_scope_variables_union( @plans )\fR" 4
.IX Item "in_scope_variables_union( @plans )"
Returns the set union of \f(CW\*(C`in_scope_variables\*(C'\fR of the given plan objects.
.ie n .IP """subplans_of_type_are_variable_connected( $type )""" 4
.el .IP "\f(CWsubplans_of_type_are_variable_connected( $type )\fR" 4
.IX Item "subplans_of_type_are_variable_connected( $type )"
Returns true if the subpatterns of the given \f(CW$type\fR are all connected
through their \f(CW\*(C`in_scope_variables\*(C'\fR, false otherwise (implying a cartesian
product if the connecting plans perform some form of join.
.ie n .IP """children_are_variable_connected( $type )""" 4
.el .IP "\f(CWchildren_are_variable_connected( $type )\fR" 4
.IX Item "children_are_variable_connected( $type )"
Returns true if the children of this plan are all connected
through their \f(CW\*(C`in_scope_variables\*(C'\fR, false otherwise (implying a cartesian
product if this plan performs some form of join.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/attean/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://www.perlrdf.org/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014\-\-2016 Gregory Todd Williams.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.