.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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::Plan 3pm"
.TH Attean::Plan 3pm "2022-10-06" "perl v5.34.0" "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::Plan \- Representation of SPARQL query plan operators
.SH "VERSION"
.IX Header "VERSION"
This document describes Attean::Plan version 0.033
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use v5.14;
\&  use Attean;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a utility package that defines all the Attean query plan classes
in the Attean::Plan namespace:
.IP "\(bu" 4
Attean::Plan::Quad
.Sp
Evaluates a quad pattern against the model.
.IP "\(bu" 4
Attean::Plan::NestedLoopJoin
.Sp
Evaluates a join (natural\-, anti\-, or left\-) using a nested loop.
.IP "\(bu" 4
Attean::Plan::HashJoin
.Sp
Evaluates a join (natural\-, anti\-, or left\-) using a hash join.
.IP "\(bu" 4
Attean::Plan::Construct
.IP "\(bu" 4
Attean::Plan::Describe
.IP "\(bu" 4
Attean::Plan::EBVFilter
.Sp
Filters results from a sub-plan based on the effective boolean value of a
named variable binding.
.IP "\(bu" 4
Attean::Plan::Merge
.Sp
Evaluates a set of sub-plans, returning the merged union of results, preserving
ordering.
.IP "\(bu" 4
Attean::Plan::Union
.Sp
Evaluates a set of sub-plans, returning the union of results.
.IP "\(bu" 4
Attean::Plan::Extend
.Sp
Evaluates a sub-plan, and extends each result by evaluating a set of
expressions, binding the produced values to new variables.
.IP "\(bu" 4
Attean::Plan::HashDistinct
.Sp
Evaluates a sub-plan, and returns distinct results by checking a persistent
hash of already-seen results.
.IP "\(bu" 4
Attean::Plan::Unique
.Sp
Evaluates an already-ordered sub-plan, and returns distinct results by
filtering out sequential duplicates.
.IP "\(bu" 4
Attean::Plan::Slice
.Sp
Evaluates a sub-plan, and returns the results after optionally skipping some
number of results (\*(L"offset\*(R") and limiting the total number of returned results
(\*(L"limit\*(R").
.IP "\(bu" 4
Attean::Plan::Project
.Sp
Evaluates a sub-plan and returns projected results by only keeping a fixed-set
of variable bindings in each result.
.IP "\(bu" 4
Attean::Plan::OrderBy
.Sp
Evaluates a sub-plan and returns the results after fully materializing and
sorting is applied.
.IP "\(bu" 4
Attean::Plan::Service
.Sp
Evaluates a \s-1SPARQL\s0 query against a remote endpoint.
.IP "\(bu" 4
Attean::Plan::Table
.Sp
Returns a constant set of results.
.IP "\(bu" 4
Attean::Plan::Iterator
.Sp
Returns a constant set of results.
.Sp
Be aware that if the iterator being wrapped is not repeatable (consuming the
Attean::API::RepeatableIterator role), then this plan may only be evaluated
once.
.Sp
A size estimate may be given if it is available. If the iterator is an
Attean::ListIterator, the size of that iterator will be used.
.IP "\(bu" 4
Attean::Plan::ALPPath
.IP "\(bu" 4
Attean::Plan::Exists
.Sp
Returns an iterator containing a single boolean term indicating whether any
results were produced by evaluating the sub-plan.
.IP "\(bu" 4
Attean::Plan::Aggregate
.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"
.SH "AUTHOR"
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014\-\-2022 Gregory Todd Williams.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.