tomo-Int.choose.3

(36 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Int.choose 3 2026-01-19 "Tomo man-pages"
   6 .SH NAME
   7 Int.choose \- binomial coefficient
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Int.choose\ :\ func(n:\ Int,\ k:\ Int\ ->\ Int)
  13 .fi
  14 .SH DESCRIPTION
  15 Computes the binomial coefficient of the given numbers (the equivalent of `n` choose `k` in combinatorics). This is equal to `n.factorial()/(k.factorial() * (n-k).factorial())`.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 n	Int	The number of things to choose from. 
  26 k	Int	The number of things to be chosen. 
  27 .TE
  28 .SH RETURN
  29 The binomial coefficient, equivalent to the number of ways to uniquely choose `k` objects from among `n` objects, ignoring order.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert 4.choose(2) == 6
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Int (3)