aboutsummaryrefslogtreecommitdiff
path: root/man/man3
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-21 14:55:19 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-21 14:55:19 -0400
commit3b1acb8ac5788061b90aeb9069ddecacf265f20c (patch)
tree22b9a03a9046690683cb9d29aeedf4a9f4d2f5d9 /man/man3
parentaa5578ffe8fb2a9e6d24b0077f5d7ced630b7dfa (diff)
Add missing files
Diffstat (limited to 'man/man3')
-rw-r--r--man/man3/tomo-List.where.3 (renamed from man/man3/tomo-List.first.3)10
1 files changed, 5 insertions, 5 deletions
diff --git a/man/man3/tomo-List.first.3 b/man/man3/tomo-List.where.3
index a8183cc8..88520918 100644
--- a/man/man3/tomo-List.first.3
+++ b/man/man3/tomo-List.where.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.first 3 2025-04-21T14:44:34.258746 "Tomo man-pages"
+.TH List.where 3 2025-04-21T14:54:02.045598 "Tomo man-pages"
.SH NAME
-List.first \- find an index where a predicate matches
+List.where \- find an index where a predicate matches
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI List.first\ :\ func(list:\ [T],\ predicate:\ func(item:&T\ ->\ Bool)\ ->\ Int)
+.BI List.where\ :\ func(list:\ [T],\ predicate:\ func(item:&T\ ->\ Bool)\ ->\ Int)
.fi
.SH DESCRIPTION
Find the index of the first item that matches a predicate function (if any).
@@ -23,14 +23,14 @@ lb lb lbx lb
l l l l.
Name Type Description Default
list [T] The list to search through. -
-predicate func(item:&T -> Bool) A function that returns `yes` if the item should be returned or `no` if it should not. -
+predicate func(item:&T -> Bool) A function that returns `yes` if the item's index should be returned or `no` if it should not. -
.TE
.SH RETURN
Returns the index of the first item where the predicate is true or `!Int` if no item matches.
.SH EXAMPLES
.EX
->> [4, 5, 6].find(func(i:&Int): i.is_prime())
+>> [4, 5, 6].where(func(i:&Int): i.is_prime())
= 5 : Int?
>> [4, 6, 8].find(func(i:&Int): i.is_prime())
= none : Int?