.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Cache::LRU 3pm"
.TH Cache::LRU 3pm "2021-01-03" "perl v5.32.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"
Cache::LRU \- a simple, fast implementation of LRU cache in pure perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Cache::LRU;
\&
\&    my $cache = Cache::LRU\->new(
\&        size => $max_num_of_entries,
\&    );
\&
\&    $cache\->set($key => $value);
\&
\&    $value = $cache\->get($key);
\&
\&    $removed_value = $cache\->remove($key);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Cache::LRU is a simple, fast implementation of an in-memory \s-1LRU\s0 cache in pure perl.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS "Cache::LRU\->new(size => $max_num_of_entries)"
.el .SS "Cache::LRU\->new(size => \f(CW$max_num_of_entries\fP)"
.IX Subsection "Cache::LRU->new(size => $max_num_of_entries)"
Creates a new cache object.  Takes a hash as the only argument.  The only parameter currently recognized is the \f(CW\*(C`size\*(C'\fR parameter that specifies the maximum number of entries to be stored within the cache object.
.ie n .SS "$cache\->get($key)"
.el .SS "\f(CW$cache\fP\->get($key)"
.IX Subsection "$cache->get($key)"
Returns the cached object if exists, or undef otherwise.
.ie n .SS "$cache\->set($key => $value)"
.el .SS "\f(CW$cache\fP\->set($key => \f(CW$value\fP)"
.IX Subsection "$cache->set($key => $value)"
Stores the given key-value pair.
.ie n .SS "$cache\->remove($key)"
.el .SS "\f(CW$cache\fP\->remove($key)"
.IX Subsection "$cache->remove($key)"
Removes data associated to the given key and returns the old value, if any.
.ie n .SS "$cache\->clear($key)"
.el .SS "\f(CW$cache\fP\->clear($key)"
.IX Subsection "$cache->clear($key)"
Removes all entries from the cache.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kazuho Oku
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Cache
.PP
Cache::Ref
.PP
Tie::Cache::LRU
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>