.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "KinoSearch1::Store::RAMInvIndex 3pm"
.TH KinoSearch1::Store::RAMInvIndex 3pm 2024-03-10 "perl v5.38.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
KinoSearch1::Store::RAMInvIndex \- in\-memory InvIndex
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    my $invindex = KinoSearch1::Store::RAMInvIndex\->new(
\&        path   => \*(Aq/path/to/invindex\*(Aq,
\&    );
\&
\&    # or...
\&    my $invindex = KinoSearch1::Store::RAMInvIndex\->new;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
RAMInvIndex is an entirely in-memory implementation of
KinoSearch1::Store::InvIndex.  It serves two main purposes.
.PP
First, it's possible to load an existing FSInvIndex into memory, which can
improve search-speed \-\- if you have that kind of RAM to spare.  Needless to
say, any FSInvIndex you try to load this way should be appropriately modest in
size.
.PP
Second, RAMInvIndex is handy for testing and development.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.SS new
.IX Subsection "new"
Create a RAMInvIndex object.  \f(CW\*(C`new\*(C'\fR takes one optional parameter, \f(CW\*(C`path\*(C'\fR. If
\&\f(CW\*(C`path\*(C'\fR is supplied, KinoSearch1 will try to read an FSInvIndex at that
location into memory.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2005\-2010 Marvin Humphrey
.SH "LICENSE, DISCLAIMER, BUGS, etc."
.IX Header "LICENSE, DISCLAIMER, BUGS, etc."
See KinoSearch1 version 1.01.