Merge pull request #12 from nomennescio/feature-margins

Feature: margins

Author: nomennescio

.dockerignore

@@ -1,5 +1,6 @@
 # Copyright 2022 nomennescio, see LICENCSE.md for license
 .git
+.github
 .dockerignore
 Dockerfile
 **/*.md

.github/workflows/test.yml

@@ -15,4 +15,4 @@ jobs:
           wget -q -O - https://downloads.factorcode.org/releases/0.98/factor-linux-x86-64-0.98.tar.gz | tar xzf -
       - name: Run Tests
         run: |
-          PATH=~/opt/factor:$PATH python test/run-tests.py -v
+          PATH=~/opt/factor:$PATH python3 test/run-tests.py -v

Dockerfile

@@ -18,6 +18,7 @@ RUN set -ex; \
 
 COPY tools/testest/testest.factor /opt/factor/work/tools/testest/testest.factor
 COPY codewars/imager/imager.factor /opt/factor/work/codewars/imager/imager.factor
+COPY math/margins/margins.factor /opt/factor/pre/math/margins/margins.factor
 
 RUN set -ex; \
     cd /opt; \

README.md

@@ -2,7 +2,9 @@
 
 Vocabulary to test Factor code on Codewars.
 
-### Example
+See [documentation](testest.md)
+
+### Example testest setup
 
 See [example](./example).
 

codewars/imager/imager.factor

@@ -1,11 +1,12 @@
 ! Copyright (C) 2022 nomennescio
 ! see LICENSE.md for license
 
-USING: memory system vocabs vocabs.hierarchy ;
+USING: memory namespaces sequences sequences.rotated system vectors vocabs vocabs.hierarchy vocabs.loader ;
 IN: codewars.imager
 
 : load-and-save-image ( -- )
-  "resource:core" load-root "resource:basis" load-root "tools.testest" require
+  "resource:pre" add-vocab-root vocab-roots [ -1 <rotated> >vector ] change-global
+  "resource:extra" vocab-roots get remove [ load-root ] each
   image-path save-image-and-exit
 ;
 

math/margins/authors.txt

@@ -0,0 +1 @@
+nomennescio

math/margins/margins.factor

@@ -0,0 +1,76 @@
+! Copyright 2022 nomennescio
+! See LICENSE.md for license
+
+! margins are like intervals with a central value and left and right acceptable margins
+! margins compare equal if one contains the other, to support inexact comparisons using equal ("=")
+
+USING: accessors combinators.short-circuit kernel locals make math math.intervals math.parser present prettyprint.custom prettyprint.sections sequences ;
+IN: math.margins
+
+<PRIVATE
+
+: -.+ ( a b -- a-b a a+b ) [ - ] [ drop ] [ + ] 2tri ;
+
+! class
+
+TUPLE: margin { range interval read-only } { central real read-only } ; ! preferably margin would be a subclass of interval, but we can't reuse its constructor
+TUPLE: abs-margin < margin ; ! margin class with absolute margin
+TUPLE: rel-margin < margin ; ! margin class with margin as percentage of central value
+
+! constructors
+
+ERROR: unordered-margin ; ! guards invariant from<=central<=to
+
+:: boa-margin ( from central to class -- margin ) from central <= central to <= and [ from to [a,b] central ] [ unordered-margin ] if class boa ; inline
+
+PRIVATE>
+
+: <margin> ( from central to -- margin ) margin boa-margin ;
+: [a-e,a+e] ( a epsilon -- margin ) abs -.+ abs-margin boa-margin ;
+: [a-%,a+%] ( a percent -- margin ) over * 100 / abs -.+ rel-margin boa-margin ;
+
+ALIAS: ±  [a-e,a+e]
+ALIAS: ±% [a-%,a+%]
+
+! methods
+
+! convert object to margin. prerequisite for comparisons
+
+GENERIC: >margin ( obj -- margin )
+
+M: object >margin drop f ;
+M: margin >margin ;
+M: real >margin dup dup <margin> ;
+
+ALIAS: >± >margin
+
+<PRIVATE
+
+! margins compare equal if one contains the other (not a true equality because it's reflexive and symmetric, but not transitive)
+
+M: margin hashcode* 2drop 0xbef001ed ; ! semi-unique singular value
+M: margin equal? over margin? [ [ range>> ] bi@ { [ interval-subset? ] [ swap interval-subset? ] } 2|| ] [ 2drop f ] if ;
+
+! extract values from margin
+
+: margin> ( margin -- from central to ) [ range>> [ from>> ] [ to>> ] bi [ first ] bi@ ] [ central>> ] bi swap ;
+
+! >string conversions
+
+! specific
+
+:     margin>string (     margin -- string ) margin> spin [ # "«" % # "»" % # ] "" make ;
+: abs-margin>string ( abs-margin -- string ) margin> spin drop [ - ] keep [ # "±" % # ] "" make ;
+: rel-margin>string ( rel-margin -- string ) margin> spin drop [ [ - ] keep abs / 100 * ] keep [ # "±" % # "%" % ] "" make ;
+
+! generic
+
+M:     margin present     margin>string ;
+M: abs-margin present abs-margin>string ;
+M: rel-margin present rel-margin>string ;
+
+! custom prettyprinting
+
+M: margin pprint* present text ;
+
+PRIVATE>

test/README.md

@@ -3,6 +3,6 @@ Simple tests to verify the Factor Testest framework is still working
 Run all tests by executing
 run-tests.py
 
-Requires Python 2 or 3 and Factor to be in your PATH
+Requires Python 3 and Factor to be in your PATH
 
 To show more verbose output, use -v, to show less verbose output, use -q

test/run-tests.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # Copyright 2019-2022 nomennescio
 
 import glob, os, re, sys

test/test-math-margins-public.expected

@@ -0,0 +1,42 @@
+
+<DESCRIBE::>math.margins
+
+<IT::>constructors
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>0.179599 ms
+
+<IT::>constructors aliases
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>0.013899 ms
+
+<IT::>conversion
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>0.076472 ms
+
+<IT::>equals
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>0.050478 ms
+
+<COMPLETEDIN::>0.659280 ms