.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 "RDF::Trine::Pattern 3pm" .TH RDF::Trine::Pattern 3pm "2018-11-03" "perl v5.28.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" RDF::Trine::Pattern \- Class for basic graph patterns .SH "VERSION" .IX Header "VERSION" This document describes RDF::Trine::Pattern version 1.019 .SH "METHODS" .IX Header "METHODS" .ie n .IP """new ( @triples )""" 4 .el .IP "\f(CWnew ( @triples )\fR" 4 .IX Item "new ( @triples )" Returns a new BasicGraphPattern structure. .ie n .IP """construct_args""" 4 .el .IP "\f(CWconstruct_args\fR" 4 .IX Item "construct_args" Returns a list of arguments that, passed to this class' constructor, will produce a clone of this algebra pattern. .ie n .IP """triples""" 4 .el .IP "\f(CWtriples\fR" 4 .IX Item "triples" Returns a list of triples belonging to this \s-1BGP.\s0 .ie n .IP """type""" 4 .el .IP "\f(CWtype\fR" 4 .IX Item "type" .PD 0 .ie n .IP """sse""" 4 .el .IP "\f(CWsse\fR" 4 .IX Item "sse" .PD Returns the \s-1SSE\s0 string for this algebra expression. .ie n .IP """referenced_variables""" 4 .el .IP "\f(CWreferenced_variables\fR" 4 .IX Item "referenced_variables" Returns a list of the variable names used in this algebra expression. .ie n .IP """definite_variables""" 4 .el .IP "\f(CWdefinite_variables\fR" 4 .IX Item "definite_variables" Returns a list of the variable names that will be bound after evaluating this algebra expression. .ie n .IP """clone""" 4 .el .IP "\f(CWclone\fR" 4 .IX Item "clone" .PD 0 .ie n .IP """bind_variables ( \e%bound )""" 4 .el .IP "\f(CWbind_variables ( \e%bound )\fR" 4 .IX Item "bind_variables ( %bound )" .PD Returns a new pattern with variables named in \f(CW%bound\fR replaced by their corresponding bound values. .ie n .IP """subsumes ( $statement )""" 4 .el .IP "\f(CWsubsumes ( $statement )\fR" 4 .IX Item "subsumes ( $statement )" Returns true if the pattern will subsume the \f(CW$statement\fR when matched against a triple store. .ie n .IP """merge_patterns ( @patterns )""" 4 .el .IP "\f(CWmerge_patterns ( @patterns )\fR" 4 .IX Item "merge_patterns ( @patterns )" Given an array of patterns, this will merge them into one. .ie n .IP """sort_for_join_variables""" 4 .el .IP "\f(CWsort_for_join_variables\fR" 4 .IX Item "sort_for_join_variables" Returns a new pattern object with the subpatterns of the referrant sorted based on heuristics that ensure firstly that patterns can be joined on the same variable and secondly on the usual selectivity (i.e. how quickly the engine can drill down to the answer) of triple patterns. Calls \f(CW\*(C`subgroup\*(C'\fR, \f(CW\*(C`sort_triples\*(C'\fR and \f(CW\*(C`merge_patterns\*(C'\fR in that order. .ie n .IP """subgroup""" 4 .el .IP "\f(CWsubgroup\fR" 4 .IX Item "subgroup" Splits the pattern object up in an array of pattern objects where the same triple patterns occur. It will group on common variables, so that triple patterns can be joined together is in a group together. It will also group triples that have no connection to other triples in a group. It will then order the groups, first by number triples with common variables, then by number of literals, then by the total number of terms that are not variables. .ie n .IP """sort_triples""" 4 .el .IP "\f(CWsort_triples\fR" 4 .IX Item "sort_triples" Will sort the triple patterns based on heuristics that looks at how many variables the patterns have, and where they occur, see \s-1REFERENCES\s0 for details. Returns a new sorted pattern object. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to through the GitHub web interface at . .SH "REFERENCES" .IX Header "REFERENCES" The heuristics to order triple patterns in this module is strongly influenced by The ICS-FORTH Heuristics-based \s-1SPARQL\s0 Planner (\s-1HSP\s0) . .SH "AUTHOR" .IX Header "AUTHOR" Gregory Todd Williams \f(CW\*(C`\*(C'\fR .PP Kjetil Kjernsmo \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2006\-2012 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.