.\" Automatically generated by Pod::Man 4.11 (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 "Data::Password::zxcvbn::Combinatorics 3pm"
.TH Data::Password::zxcvbn::Combinatorics 3pm "2020-07-13" "perl v5.30.3" "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"
Data::Password::zxcvbn::Combinatorics \- some combinatorial functions
.SH "VERSION"
.IX Header "VERSION"
version 1.0.4
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a few combinatorial functions that are used
throughout the library.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS """nCk"""
.el .SS "\f(CWnCk\fP"
.IX Subsection "nCk"
.Vb 1
\&  my $combinations = nCk($available,$taken);
.Ve
.PP
Returns the binomial coefficient:
.PP
.Vb 3
\& / $available \e
\& |            |
\& \e   $taken   /
.Ve
.ie n .SS """enumerate_substitution_maps"""
.el .SS "\f(CWenumerate_substitution_maps\fP"
.IX Subsection "enumerate_substitution_maps"
.Vb 1
\& my $enumeration = enumerate_substitution_maps(\e%substitutions);
.Ve
.PP
Given a hashref of arrayrefs, interprets it as a map of
substitutions. Returns an arrayref of hashrefs, containing all
reverse-substitutions.
.PP
For example, given:
.PP
.Vb 1
\& {\*(Aqa\*(Aq => [\*(Aq@\*(Aq, \*(Aq4\*(Aq]}
.Ve
.PP
(\*(L"'a' can be replaced with either '@' or '4'\*(R")
.PP
it returns:
.PP
.Vb 1
\&  [{\*(Aq@\*(Aq => \*(Aqa\*(Aq}, {\*(Aq4\*(Aq => \*(Aqa\*(Aq}] ],
.Ve
.PP
(\*(L"in one case, '@' could have been substituted for 'a'; in the other,
\&'4' could have been substituted for 'a'\*(R")
.ie n .SS """factorial"""
.el .SS "\f(CWfactorial\fP"
.IX Subsection "factorial"
.Vb 1
\&  my $fact = factorial($number);
.Ve
.PP
Returns the factorial of the given number.
.SH "AUTHOR"
.IX Header "AUTHOR"
Gianni Ceccarelli <gianni.ceccarelli@broadbean.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by BroadBean \s-1UK,\s0 a CareerBuilder Company.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.