.\" 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 "AtteanX::Store::MemoryTripleStore 3pm"
.TH AtteanX::Store::MemoryTripleStore 3pm "2015-08-11" "perl v5.22.1" "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"
AtteanX::Store::MemoryTripleStore \- In\-memory RDF triple store
.SH "VERSION"
.IX Header "VERSION"
This document describes AtteanX::Store::MemoryTripleStore version 0.001
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use AtteanX::Store::MemoryTripleStore;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
AtteanX::Store::MemoryTripleStore provides an in-memory triple-store that is
especially optimized for matching BGPs which contain at least one bound subject
or object (e.g. preferring star or path queries rather than analytical
queries).
.PP
The triple store is read-only, requiring a filename to be specified during
construction which points at an N\-Triples or Turtle file containing the \s-1RDF\s0
data to load. The triple store links with libraptor2 to allow fast parsing of
input files.
.SH "METHODS"
.IX Header "METHODS"
Beyond the methods documented below, this class consumes the
Attean::API::TripleStore and Attean::API::CostPlanner roles.
.ie n .IP """new (filename => $filename)""" 4
.el .IP "\f(CWnew (filename => $filename)\fR" 4
.IX Item "new (filename => $filename)"
Returns a new memory-backed storage object containing the \s-1RDF\s0 data parsed from
the specified N\-Triples\- or Turtle-encoded file.
.ie n .IP """get_triples ( $subject, $predicate, $object )""" 4
.el .IP "\f(CWget_triples ( $subject, $predicate, $object )\fR" 4
.IX Item "get_triples ( $subject, $predicate, $object )"
Returns an iterator object of all Attean::API::Triple objects matching the
specified subject, predicate and objects. Any of the arguments may be undef to
match any value, an Attean::API::Term object, or an \s-1ARRAY\s0 reference
containing a set of possible term values.
.ie n .IP """plans_for_algebra ( $algebra )""" 4
.el .IP "\f(CWplans_for_algebra ( $algebra )\fR" 4
.IX Item "plans_for_algebra ( $algebra )"
If \f(CW$algebra\fR is an Attean::Algebra::BGP object, returns a store-specific
Attean::API::Plan object representing the evaluation of the entire \s-1BGP\s0
against the triplestore.
.Sp
Otherwise, returns an empty list.
.ie n .IP """cost_for_plan ( $plan )""" 4
.el .IP "\f(CWcost_for_plan ( $plan )\fR" 4
.IX Item "cost_for_plan ( $plan )"
If \f(CW$plan\fR is a recognized store-specific Attean::API::Plan object,
returns an estimated (relative) cost value for evaluating the represented \s-1BGP.\s0
.Sp
Otherwise returns \f(CW\*(C`undef\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/atteanx\-store\-memorytriplestore/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) 2015 Gregory Todd Williams.
This program is free software; you can redistribute it and/or modify it under
the terms of the \s-1GNU\s0 General Public License.