add docs and provide from unstable/lens
This commit is contained in:
parent
0f2512ec9f
commit
52d6d79f77
54
unstable/lens/isomorphism.scrbl
Normal file
54
unstable/lens/isomorphism.scrbl
Normal file
|
@ -0,0 +1,54 @@
|
|||
#lang scribble/manual
|
||||
|
||||
@(require lens/doc-util/main)
|
||||
|
||||
@title{Isomorphisms}
|
||||
|
||||
@defmodule[unstable/lens/isomorphism]
|
||||
|
||||
@defproc[(isomorphism-lens [f (a/c . -> . b/c)] [inv (b/c . -> . a/c)]) lens?]{
|
||||
Creates a lens for an isomorphism. The @racket[f] argument should be a function
|
||||
with an inverse, and the @racket[inv] argument should be its inverse.
|
||||
The @racket[f] function converts targets to views, and the @racket[inv] function
|
||||
converts views to targets.
|
||||
|
||||
So for instance a @racket[symbol->string-lens] could be defined with:
|
||||
@racketblock[
|
||||
(define symbol->string-lens
|
||||
(isomorphism-lens symbol->string string->symbol))
|
||||
]
|
||||
@lenses-unstable-examples[
|
||||
(lens-view symbol->string-lens 'something)
|
||||
(lens-transform symbol->string-lens 'something (λ (s) (string-append "make-" s)))
|
||||
]}
|
||||
|
||||
@defproc[(isomorphism-lens? [v any/c]) boolean?]{
|
||||
A predicate that returns true when @racket[v] is a lens constructed with
|
||||
@racket[isomorphism-lens], @racket[isomorphism-lens-inverse], or
|
||||
@racket[isomorphism-lenses], and returns false otherwise.
|
||||
All isomorphism lenses are also lenses according to @racket[lens?].
|
||||
}
|
||||
|
||||
@defproc[(isomorphism-lens-inverse [iso-lens isomorphism-lens?]) isomorphism-lens?]{
|
||||
Returns the inverse of @racket[iso-lens].
|
||||
}
|
||||
|
||||
@defproc[(isomorphism-lenses [f (a/c . -> . b/c)] [inv (b/c . -> . a/c)])
|
||||
(values isomorphism-lens? isomorphism-lens?)]{
|
||||
Returns two values. The first value is the result of
|
||||
@racket[(isomorphism-lens f inv)], and the second value is the inverse of that
|
||||
lens.
|
||||
|
||||
The lenses @racket[symbol->string-lens] and @racket[string->symbol-lens], for
|
||||
example, are defined like this:
|
||||
@racketblock[
|
||||
(define-values [string->symbol-lens symbol->string-lens]
|
||||
(isomorphism-lenses string->symbol symbol->string))
|
||||
]}
|
||||
|
||||
@deflenses[[string->symbol-lens symbol->string-lens
|
||||
number->string-lens string->number-lens
|
||||
list->vector-lens vector->list-lens
|
||||
list->string-lens string->list-lens]]{
|
||||
Isomorphim lenses for @racket[string->symbol], @racket[number->string], and so on.
|
||||
}
|
|
@ -3,9 +3,13 @@
|
|||
(require "syntax.rkt"
|
||||
"view-set.rkt"
|
||||
"sublist.rkt"
|
||||
"arrow.rkt")
|
||||
"arrow.rkt"
|
||||
"isomorphism.rkt"
|
||||
)
|
||||
|
||||
(provide (all-from-out "syntax.rkt"
|
||||
"view-set.rkt"
|
||||
"sublist.rkt"
|
||||
"arrow.rkt"))
|
||||
"arrow.rkt"
|
||||
"isomorphism.rkt"
|
||||
))
|
||||
|
|
|
@ -13,3 +13,4 @@ this library being backwards-compatible.
|
|||
@include-section["syntax.scrbl"]
|
||||
@include-section["sublist.scrbl"]
|
||||
@include-section["arrow.scrbl"]
|
||||
@include-section["isomorphism.scrbl"]
|
||||
|
|
Loading…
Reference in New Issue
Block a user