Urbit Docs
  • What is Urbit?
  • Get on Urbit
  • Build on Urbit
    • Contents
    • Environment Setup
    • Hoon School
      • 1. Hoon Syntax
      • 2. Azimuth (Urbit ID)
      • 3. Gates (Functions)
      • 4. Molds (Types)
      • 5. Cores
      • 6. Trees and Addressing
      • 7. Libraries
      • 8. Testing Code
      • 9. Text Processing I
      • 10. Cores and Doors
      • 11. Data Structures
      • 12. Type Checking
      • 13. Conditional Logic
      • 14. Subject-Oriented Programming
      • 15. Text Processing II
      • 16. Functional Programming
      • 17. Text Processing III
      • 18. Generic and Variant Cores
      • 19. Mathematics
    • App School I
      • 1. Arvo
      • 2. The Agent Core
      • 3. Imports and Aliases
      • 4. Lifecycle
      • 5. Cards
      • 6. Pokes
      • 7. Structures and Marks
      • 8. Subscriptions
      • 9. Vanes
      • 10. Scries
      • 11. Failure
      • 12. Next Steps
      • Appendix: Types
    • App School II (Full-Stack)
      • 1. Types
      • 2. Agent
      • 3. JSON
      • 4. Marks
      • 5. Eyre
      • 6. React app setup
      • 7. React app logic
      • 8. Desk and glob
      • 9. Summary
    • Core Academy
      • 1. Evaluating Nock
      • 2. Building Hoon
      • 3. The Core Stack
      • 4. Arvo I: The Main Sequence
      • 5. Arvo II: The Boot Sequence
      • 6. Vere I: u3 and the Serf
      • 7. Vere II: The Loom
      • 8. Vanes I: Behn, Dill, Kahn, Lick
      • 9. Vanes II: Ames
      • 10. Vanes III: Eyre, Iris
      • 11. Vanes IV: Clay
      • 12. Vanes V: Gall and Userspace
      • 13. Vanes VI: Khan, Lick
      • 14. Vanes VII: Jael, Azimuth
    • Runtime
      • U3
      • Conn.c Guide
      • How to Write a Jet
      • API Overview by Prefix
      • C in Urbit
      • Cryptography
      • Land of Nouns
    • Tools
      • Useful Links
      • JS Libraries
        • HTTP API
      • Docs App
        • File Format
        • Index File
        • Suggested Structure
    • Userspace
      • Command-Line App Tutorial
      • Remote Scry
      • Unit Tests
      • Software Distribution
        • Software Distribution Guide
        • Docket File
        • Glob
      • Examples
        • Building a CLI App
        • Debugging Wrapper
        • Host a Website
        • Serving a JS Game
        • Ship Monitoring
        • Styled Text
  • Urbit ID
    • What is Urbit ID?
    • Azimuth Data Flow
    • Life and Rift
    • Urbit HD Wallet
    • Advanced Azimuth Tools
    • Custom Roller Tutorial
    • Azimuth.eth Reference
    • Ecliptic.eth Reference
    • Layer 2
      • L2 Actions
      • L2 Rollers
      • L2 Roller HTTP RPC-API
      • L2 Transaction Format
  • Urbit OS
    • What is Urbit OS?
    • Base
      • Hood
      • Threads
        • Basics Tutorial
          • Bind
          • Fundamentals
          • Input
          • Output
          • Summary
        • HTTP API Guide
        • Spider API Reference
        • Strandio Reference
        • Examples
          • Child Thread
          • Fetch JSON
          • Gall
            • Poke Thread
            • Start Thread
            • Stop Thread
            • Take Facts
            • Take Result
          • Main-loop
          • Poke Agent
          • Scry
          • Take Fact
    • Kernel
      • Arvo
        • Cryptography
        • Move Trace
        • Scries
        • Subscriptions
      • Ames
        • Ames API Reference
        • Ames Cryptography
        • Ames Data Types
        • Ames Scry Reference
      • Behn
        • Behn API Reference
        • Behn Examples
        • Behn Scry Reference
      • Clay
        • Clay API Reference
        • Clay Architecture
        • Clay Data Types
        • Clay Examples
        • Clay Scry Reference
        • Filesystem Hierarchy
        • Marks
          • Mark Examples
          • Using Marks
          • Writing Marks
        • Using Clay
      • Dill
        • Dill API Reference
        • Dill Data Types
        • Dill Scry Reference
      • Eyre
        • EAuth
        • Eyre Data Types
        • Eyre External API
        • Eyre Internal API
        • Eyre Scry Reference
        • Low-Level Eyre Guide
        • Noun channels
      • Gall
        • Gall API Reference
        • Gall Data Types
        • Gall Scry Reference
      • Iris
        • Iris API Reference
        • Iris Data Types
        • Iris Example
      • Jael
        • Jael API Reference
        • Jael Data Types
        • Jael Examples
        • Jael Scry Reference
      • Khan
        • Khan API Reference
        • Khan Data Types
        • Khan Example
      • Lick
        • Lick API Reference
        • Lick Guide
        • Lick Examples
        • Lick Scry Reference
  • Hoon
    • Why Hoon?
    • Advanced Types
    • Arvo
    • Auras
    • Basic Types
    • Cheat Sheet
    • Cryptography
    • Examples
      • ABC Blocks
      • Competitive Programming
      • Emirp
      • Gleichniszahlenreihe
      • Islands
      • Luhn Number
      • Minimum Path Sum
      • Phone Letters
      • Restore IP
      • Rhonda Numbers
      • Roman Numerals
      • Solitaire Cipher
      • Water Towers
    • Generators
    • Hoon Errors
    • Hoon Style Guide
    • Implementing an Aura
    • Irregular forms
    • JSON
    • Limbs and wings
      • Limbs
      • Wings
    • Mips (Maps of Maps)
    • Parsing Text
    • Runes
      • | bar · Cores
      • $ buc · Structures
      • % cen · Calls
      • : col · Cells
      • . dot · Nock
      • / fas · Imports
      • ^ ket · Casts
      • + lus · Arms
      • ; mic · Make
      • ~ sig · Hints
      • = tis · Subject
      • ? wut · Conditionals
      • ! zap · Wild
      • Constants (Atoms and Strings)
      • --, == · Terminators
    • Sail (HTML)
    • Serialization
    • Sets
    • Standard Library
      • 1a: Basic Arithmetic
      • 1b: Tree Addressing
      • 1c: Molds and Mold-Builders
      • 2a: Unit Logic
      • 2b: List Logic
      • 2c: Bit Arithmetic
      • 2d: Bit Logic
      • 2e: Insecure Hashing
      • 2f: Noun Ordering
      • 2g: Unsigned Powers
      • 2h: Set Logic
      • 2i: Map Logic
      • 2j: Jar and Jug Logic
      • 2k: Queue Logic
      • 2l: Container from Container
      • 2m: Container from Noun
      • 2n: Functional Hacks
      • 2o: Normalizing Containers
      • 2p: Serialization
      • 2q: Molds and Mold-Builders
      • 3a: Modular and Signed Ints
      • 3b: Floating Point
      • 3c: Urbit Time
      • 3d: SHA Hash Family
      • 3e: AES encryption (Removed)
      • 3f: Scrambling
      • 3g: Molds and Mold-Builders
      • 4a: Exotic Bases
      • 4b: Text Processing
      • 4c: Tank Printer
      • 4d: Parsing (Tracing)
      • 4e: Parsing (Combinators)
      • 4f: Parsing (Rule-Builders)
      • 4g: Parsing (Outside Caller)
      • 4h: Parsing (ASCII Glyphs)
      • 4i: Parsing (Useful Idioms)
      • 4j: Parsing (Bases and Base Digits)
      • 4k: Atom Printing
      • 4l: Atom Parsing
      • 4m: Formatting Functions
      • 4n: Virtualization
      • 4o: Molds
      • 5a: Compiler Utilities
      • 5b: Macro Expansion
      • 5c: Compiler Backend & Prettyprinter
      • 5d: Parser
      • 5e: Molds and mold builders
      • 5f: Profiling support
    • Strings
    • The Engine Pattern
    • Udon (Markdown-esque)
    • Vases
    • Zuse
      • 2d(1-5): To JSON, Wains
      • 2d(6): From JSON
      • 2d(7): From JSON (unit)
      • 2e(2-3): Print & Parse JSON
      • 2m: Ordered Maps
  • Nock
    • What is Nock?
    • Decrement
    • Definition
    • Fast Hints and Jets
    • Implementations
    • Specification
  • User Manual
    • Contents
    • Running Urbit
      • Cloud Hosting
      • Home Servers
      • Runtime Reference
      • Self-hosting S3 Storage with MinIO
    • Urbit ID
      • Bridge Troubleshooting
      • Creating an Invite Pool
      • Get an Urbit ID
      • Guide to Factory Resets
      • HD Wallet (Master Ticket)
      • Layer 2 for planets
      • Layer 2 for stars
      • Proxies
      • Using Bridge
    • Urbit OS
      • Basics
      • Configuring S3 Storage
      • Dojo Tools
      • Filesystem
      • Shell
      • Ship Troubleshooting
      • Star and Galaxy Operations
      • Updates
Powered by GitBook

GitHub

  • Urbit ID
  • Urbit OS
  • Runtime

Resources

  • YouTube
  • Whitepaper
  • Awesome Urbit

Contact

  • X
  • Email
  • Gather
On this page
  • +biff
  • +bind
  • +bond
  • +both
  • +clap
  • +clef
  • +drop
  • +fall
  • +flit
  • +hunt
  • +lift
  • +mate
  • +need
  • +some
Edit on GitHub
  1. Hoon
  2. Standard Library

2a: Unit Logic

+biff

Unit as argument

Applies a function b that produces a unit to the unwrapped value of unit a (u.a). If a is empty, ~ is produced.

Accepts

a is a unit.

b is a function that accepts a noun and produces a unit.

Produces

A unit.

Source

++  biff
  |*  [a=(unit) b=$-(* (unit))]
  ?~  a  ~
  (b u.a)

Examples

> (biff (some 5) |=(a=@ (some (add a 2))))
[~ u=7]
> (biff ~ |=(a=@ (some (add a 2))))
~

+bind

Non-unit function to unit, producing unit

Applies a function b to the value (u.a) of a unit a, producing a unit. Used when you want a function that does not accept or produce a unit to both accept and produce a unit.

Accepts

a is a unit.

b is a function.

Produces

A unit.

Source

++  bind
  |*  [a=(unit) b=gate]
  ?~  a  ~
  [~ u=(b u.a)]

Examples

> (bind ((unit @) [~ 97]) ,@t)
[~ u='a']
> =a |=(a=@ (add a 1))
> (bind ((unit @) [~ 2]) a)
[~ u=3]

+bond

Replace null

Replaces an empty unit b with the product of a called trap a. If the unit is not empty, then the original unit is produced.

Accepts

a is a trap.

b is a unit.

Produces

Either the product of a or the value inside of unit b.

Source

++  bond
  |*  a=(trap)
  |*  b=(unit)
  ?~  b  $:a
  u.b

Examples

    > (bex 10)
    1.024
    > ((bond |.((bex 10))) ~)
    1.024
    > ((bond |.((bex 10))) (slaw %ud '123'))
    123

+both

Group unit values into pair

Produces ~ if either a or b are empty. Otherwise, produces a unit whose value is a cell of the values of two input units a and b.

Accepts

a is a unit.

b is a unit.

Produces

A unit of the two initial values.

Source

++  both
  |*  [a=(unit) b=(unit)]
  ?~  a  ~
  ?~  b  ~
  [~ u=[u.a u.b]]

Examples

> (both (some 1) (some %b))
[~ u=[1 %b]]
> (both ~ (some %b))
~

+clap

Combine two units with function

Applies a binary function c--which does not usually accept or produce a unit-- to the values of two units, a and b, producing a unit.

If a is null, produces b. If b is null, produces a. Otherwise, produces the produce of c in a unit.

Accepts

a is a unit.

b is a unit.

c is a function that performs a binary operation.

Produces

A unit.

Source

++  clap
  |*  [a=(unit) b=(unit) c=_=>(~ |=(^ +<-))]
  ?~  a  b
  ?~  b  a
  [~ u=(c u.a u.b)]

Examples

> (clap ~ `'b' |=([a=@tD b=@tD] `tape`[a b ~]))
[~ u='b']
> (clap `'a' ~ |=([a=@tD b=@tD] `tape`[a b ~]))
[~ u='a']
> (clap `'a' `'b' |=([a=@tD b=@tD] `tape`[a b ~]))
[~ u="ab"]

+clef

Compose two units with function

Applies a binary function c--which does not usually accept units-- to the values of two units, a and b, producing a unit.

If a or b are null, produces null. Otherwise, produces the produce of c.

Accepts

a is a unit.

b is a unit.

c is a gate that takes a cell and produces a unit.

Produces

A unit.

Source

++  clef
  |*  [a=(unit) b=(unit) c=_=>(~ |=(^ `+<-))]
  ?~  a  ~
  ?~  b  ~
  (c u.a u.b)

Examples

> (clef ~ `'b' |=([a=@tD b=@tD] `(unit tape)`[~ [a b ~]]))
~
> (clef `'a' ~ |=([a=@tD b=@tD] `(unit tape)`[~ [a b ~]]))
~
> (clef `'a' `'b' |=([a=@tD b=@tD] `(unit tape)`[~ [a b ~]]))
[~ "ab"]

+drop

Unit to list

Makes a ++list of the unwrapped value (u.a) of a unit a.

Accepts

a is a unit.

Produces

A list.

Source

++  drop
  |*  a=(unit)
  ?~  a  ~
  [i=u.a t=~]

Examples

> =a ((unit @) [~ 97])
> (drop a)
[i=97 t=~]
> =a ((unit @) [~])
> (drop a)
~

+fall

Give unit a default value

Produces a default value b for a unit a in cases where a is null.

Accepts

a is a unit.

b is a noun that's used as the default value.

Produces

Either a noun b or the unwrapped value of unit a.

Source

++  fall
  |*  [a=(unit) b=*]
  ?~(a b u.a)

Examples

> (fall ~ 'a')
'a'
> (fall [~ u=0] 'a')
0

+flit

Make filter

Accepts gate a which produces a ?. Applies a to b, producing b wrapped in a unit if true, otherwise produces null.

+flit is a wet gate that takes a and produces a new wet gate that takes b.

Accepts

a is a gate which produces ?, and is the sample of the outer wet gate.

b is any noun, and is the sample of the inner wet gate.

Produces

(unit [type]), where [type] is the type of b.

Source

++  flit
  |*  a=$-(* ?)
  |*  b=*
  ?.((a b) ~ [~ u=b])

Examples

> =f (flit |=(=@ud ?:(=(ud 1) %.y %.n)))
> (f 1)
[~ 1]
> (f 2)
~

+hunt

First of units

Apply binary gate ord, which produces a ?, to units a and b. Produce a if true and b if false. If a is null, produce b. If b is null, produce a.

This allows selecting between two units by some rule.

Accepts

ord is a $-(^ ?) - a binary gate that produces ?.

a is a unit.

b is a unit.

Produces

A unit.

Source

++  hunt
  |*  [ord=$-(^ ?) a=(unit) b=(unit)]
  ^-  %-  unit
      $?  _?>(?=(^ a) u.a)
          _?>(?=(^ b) u.b)
      ==
  ?~  a  b
  ?~  b  a
  ?:((ord u.a u.b) a b)

Examples

> (hunt gte ~ `20)
[~ 20]
> (hunt gte `10 ~)
[~ 10]
> (hunt gte `10 `20)
[~ 20]

+lift

Curried bind

Accepts function a and produces a function that accepts unit b to which it applies a. Used when you want a function that does not accept or produce a unit to both accept and produce a unit.

Accepts

a is a mold.

b is a unit.

Produces

A unit.

Source

++  lift
  |*  a=mold
  |*  b=(unit)
  (bind b a)

Examples

> ((lift dec) `(unit @)`~)
~
> ((lift dec) `(unit @)`[~ 20])
[~ 19]

+mate

Choose

Accepts two units a and b whose values are expected to be equivalent. If either is empty, then the value of the other is produced. If neither are empty, it asserts that both values are the same and produces that value. If the assertion fails, ++mate crashes with 'mate' in the stack trace.

Accepts

a is a unit.

b is a unit.

Produces

A unit or crash.

Source

++  mate
  |*  [a=(unit) b=(unit)]
  ?~  b  a
  ?~  a  b
  ?.(=(u.a u.b) ~>(%mean.'mate' !!) a)

Examples

> =a ((unit @) [~ 97])
> =b ((unit @) [~ 97])
> (mate a b)
[~ 97]
> =a ((unit @) [~ 97])
> =b ((unit @) [~])
> (mate a b)
[~ 97]
> =a ((unit @) [~ 97])
> =b ((unit @) [~ 98])
> (mate a b)
! 'mate'
! exit

+need

Unwrap unit

Retrieve the value from a unit and crash if the unit is null.

Accepts

a is a unit.

Produces

Either the unwrapped value of a (u.a), or crash.

Source

++  need
  ~/  %need
  |*  a=(unit)
  ?~  a  ~>(%mean.'need' !!)
  u.a

Examples

> =a ((unit [@t @t]) [~ ['a' 'b']])
> (need a)
['a' 'b']
> =a ((unit @ud) [~ 17])
> (need a)
17
> =a ((unit @) [~])
> (need a)
! exit

+some

Wrap value in a unit

Takes any noun a and produces a unit with the value set to a.

Accepts

a is a noun.

Produces

A unit.

Source

++  some
  |*  a=*
  [~ u=a]

Examples

> (some ['a' 'b'])
[~ u=['a' 'b']]
> (some &)
[~ u=%.y]

Previous1c: Molds and Mold-BuildersNext2b: List Logic

Last updated 1 day ago