factor/extra/sets/extras/extras-docs.factor

26 lines
821 B
Factor

! Copyright (C) 2013 Doug Coleman.
! See http://factorcode.org/license.txt for BSD license.
USING: help.markup help.syntax kernel sequences sets ;
IN: sets.extras
HELP: setwise-xor
{ $values
{ "seq0" sequence } { "seq1" sequence }
{ "set" set }
}
{ $description "Converts the sequences to sets and takes the element-wise " { $link xor } ". Outputs elements that are in either set but not in both." }
{ $example
"USING: sets.extras prettyprint ;"
"{ 1 2 3 } { 2 3 4 } setwise-xor ."
"{ 1 4 }"
}
{ $notes "Known as setxor1d in numpy." } ;
ARTICLE: "sets.extras" "Extra sets words"
"The " { $vocab-link "sets.extras" } " vocabulary is a collection of words related to sets."
$nl
"To take the element-wise xor of two sequences as if they were sets:"
{ $subsections setwise-xor } ;
ABOUT: "sets.extras"