-USING: help.markup help.syntax math kernel arrays ;
+USING: arrays help.markup help.syntax kernel math ;
IN: 24-game
HELP: 24-game
{ "b" integer }
{ "c" integer }
{ "d" integer }
- { "?" "a boolean" }
+ { "?" boolean }
}
{ $description
"Tells if it is possible to win 24-game with these integers."
! Copyright (c) 2009 Samuel Tardieu.
! See See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax quotations sequences ;
+USING: help.markup help.syntax kernel quotations sequences ;
IN: backtrack
HELP: fail
{ $values
{ "true" { $quotation ( -- ? ) } }
{ "false" quotation }
- { "?" "a boolean" }
+ { "?" boolean }
}
{ $description "Execute the first quotation and returns " { $link t } " if it returns " { $link t } " itself. If it fails with " { $link fail } " or returns " { $link f } ", then the second quotation is executed and " { $link f } " is returned." } ;
! Copyright (C) 2010 Chris Double.
! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax kernel math sequences strings ;
IN: bitcoin.client
HELP: bitcoin-server
{ $values
- { "string" "a string" }
+ { "string" string }
}
{ $description
"Returns the hostname of the json-rpc server for the bitcoin client. "
HELP: bitcoin-port
{ $values
- { "n" "a number" }
+ { "n" number }
}
{ $description
"Returns the port of the json-rpc server for the bitcoin client. "
HELP: bitcoin-user
{ $values
- { "string" "a string" }
+ { "string" string }
}
{ $description
"Returns the username required to authenticate with the json-rpc "
HELP: bitcoin-password
{ $values
- { "string" "a string" }
+ { "string" string }
}
{ $description
"Returns the password required to authenticate with the json-rpc "
HELP: get-addresses-by-label
{ $values
- { "label" "a string" }
- { "seq" "a sequence" }
+ { "label" string }
+ { "seq" sequence }
}
{ $description
"Returns the list of addresses with the given label."
HELP: get-balance
{ $values
- { "n" "a number" }
+ { "n" number }
}
{ $description
"Returns the server's available balance."
HELP: get-block-count
{ $values
- { "n" "a number" }
+ { "n" number }
}
{ $description
"Returns the number of blocks in the longest block chain."
HELP: get-block-number
{ $values
- { "n" "a number" }
+ { "n" number }
}
{ $description
"Returns the block number of the latest block in the longest block chain."
HELP: get-connection-count
{ $values
- { "n" "a number" }
+ { "n" number }
}
{ $description
"Returns the number of connections to other nodes."
HELP: get-difficulty
{ $values
- { "n" "a number" }
+ { "n" number }
}
{ $description
"Returns the proof-of-work difficulty as a multiple of the minimum "
HELP: get-generate
{ $values
- { "?" "a boolean" }
+ { "?" boolean }
}
{ $description
"Returns true if the server is trying to generate bitcoins, false "
HELP: set-generate
{ $values
- { "gen" "a boolean" }
- { "n" "a number" }
+ { "gen" boolean }
+ { "n" number }
}
{ $description
"If 'gen' is true, the server starts generating bitcoins. If 'gen' is "
HELP: get-label
{ $values
- { "address" "a string" }
- { "label" "a string" }
+ { "address" string }
+ { "label" string }
}
{ $description
"Returns the label associated with the given address."
HELP: set-label
{ $values
- { "address" "a string" }
- { "label" "a string" }
+ { "address" string }
+ { "label" string }
}
{ $description
"Sets the label associateed with the given address."
HELP: remove-label
{ $values
- { "address" "a string" }
+ { "address" string }
}
{ $description
"Removes the label associated with the given address."
HELP: get-new-address
{ $values
- { "address" "a string" }
+ { "address" string }
}
{ $description
"Returns a new bitcoin address for receiving payments."
HELP: get-new-labelled-address
{ $values
- { "label" "a string" }
- { "address" "a string" }
+ { "label" string }
+ { "address" string }
}
{ $description
"Returns a new bitcoin address for receiving payments. The given "
HELP: get-received-by-address
{ $values
- { "address" "a string" }
- { "amount" "a number" }
+ { "address" string }
+ { "amount" number }
}
{ $description
"Returns the total amount received by the address in transactions "
HELP: get-confirmed-received-by-address
{ $values
- { "address" "a string" }
- { "minconf" "a number" }
- { "amount" "a number" }
+ { "address" string }
+ { "minconf" number }
+ { "amount" number }
}
{ $description
"Returns the total amount received by the address in transactions "
HELP: get-received-by-label
{ $values
- { "label" "a string" }
- { "amount" "a number" }
+ { "label" string }
+ { "amount" number }
}
{ $description
"Returns the total amount received by addresses with 'label' in transactions "
HELP: get-confirmed-received-by-label
{ $values
- { "label" "a string" }
- { "minconf" "a number" }
- { "amount" "a number" }
+ { "label" string }
+ { "minconf" number }
+ { "amount" number }
}
{ $description
"Returns the total amount received by the addresses with 'label' in transactions "
HELP: list-received-by-address
{ $values
- { "minconf" "a number" }
- { "include-empty" "a boolean" }
- { "seq" "a sequence" }
+ { "minconf" number }
+ { "include-empty" boolean }
+ { "seq" sequence }
}
{ $description
"Return a sequence containing an assoc of data about the payments an "
HELP: list-received-by-label
{ $values
- { "minconf" "a number" }
- { "include-empty" "a boolean" }
- { "seq" "a sequence" }
+ { "minconf" number }
+ { "include-empty" boolean }
+ { "seq" sequence }
}
{ $description
"Return a sequence containing an assoc of data about the payments that "
HELP: send-to-address
{ $values
- { "address" "a string" }
- { "amount" "a number" }
- { "?" "a boolean" }
+ { "address" string }
+ { "amount" number }
+ { "?" boolean }
}
{ $description
"Sends 'amount' from the server's available balance to 'address'. "
HELP: list-transactions
{ $values
- { "count" "a number" }
- { "include-generated" "a boolean" }
- { "seq" "a sequence" }
+ { "count" number }
+ { "include-generated" boolean }
+ { "seq" sequence }
}
{ $description
"Return's a sequence containing up to 'count' most recent transactions."
! Copyright (C) 2008 Doug Coleman.
! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax io.streams.string strings ;
+USING: help.markup help.syntax io.streams.string kernel
+strings ;
IN: crypto.passwd-md5
HELP: authenticate-password
{ $values
{ "shadow" string } { "password" string }
- { "?" "a boolean" } }
+ { "?" boolean } }
{ $description "Encodes the provided password and compares it to the encoded password entry from a shadowed password file." } ;
HELP: parse-shadow-password
! Copyright (C) 2010 Erik Charlebois
! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.crossref help.stylesheet help.topics help.syntax
-definitions io prettyprint summary arrays math sequences vocabs strings
-see xml.data hashtables assocs game.models.obj.private game.models
-game.models.util io.pathnames ;
+USING: assocs game.models.obj.private help.markup help.syntax
+io.pathnames kernel sequences strings ;
IN: game.models.obj
ABOUT: "game.models.obj"
{ $description "Convert a face line to a sequence of vertex attributes." } ;
HELP: push*
-{ $values { "elt" "an object" } { "seq" sequence } }
+{ $values { "elt" object } { "seq" sequence } }
{ $description "Push the value onto the sequence, keeping the sequence on the stack." } ;
HELP: push-current-model
IN: grouping.extras
HELP: group-by
-{ $values { "seq" "a sequence" } { "quot" { $quotation ( elt -- key ) } } { "groups" "a new assoc" } }
+{ $values { "seq" sequence } { "quot" { $quotation ( elt -- key ) } } { "groups" "a new assoc" } }
{ $description "Groups the elements by the key received by applying quot to each element in the sequence." }
{ $examples
{ $example
-USING: help.markup help.syntax kernel math ;
+USING: help.markup help.syntax kernel math strings ;
IN: hashcash
ARTICLE: "hashcash" "Hashcash"
{ mint mint* <hashcash> check-stamp salt } related-words
HELP: mint
-{ $values { "resource" "a string" } { "stamp" "generated stamp" } }
+{ $values { "resource" string } { "stamp" "generated stamp" } }
{ $description "This word generate a valid stamp with default parameters and the specified resource." } ;
HELP: mint*
{ $description "As " { $snippet "mint" } " but it takes an hashcash tuple as a parameter." } ;
HELP: check-stamp
-{ $values { "stamp" "a string" } { "?" boolean } }
+{ $values { "stamp" string } { "?" boolean } }
{ $description "Check for stamp's validity. Only supports hashcash version 1." } ;
HELP: salt
-{ $values { "length" integer } { "salted" "a string" } }
+{ $values { "length" integer } { "salted" string } }
{ $description "It generates a random string of " { $snippet "length" } " characters." } ;
HELP: <hashcash>
{ $description "Fetches the advertised extensions of the IMAP server." } ;
HELP: list-folders
-{ $values { "directory" string } { "folders" "a sequence" } }
+{ $values { "directory" string } { "folders" sequence } }
{ $description "Lists all folders in " { $snippet "directory" } ". Folders is a sequence of 3-tuples with the attributes, root and name of each folder matched." } ;
HELP: select-folder
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax math ;
IN: math.algebra
HELP: chinese-remainder
-{ $values { "aseq" "a sequence of integers" } { "nseq" "a sequence of positive integers" } { "x" "an integer" } }
+{ $values { "aseq" "a sequence of integers" } { "nseq" "a sequence of positive integers" } { "x" integer } }
{ $description "If " { $snippet "nseq" } " integers are pairwise coprimes, " { $snippet "x" } " is the smallest positive integer congruent to each element in " { $snippet "aseq" } " modulo the corresponding element in " { $snippet "nseq" } "." } ;
{ $description "Calculate the vector sum " { $snippet "αx + y" } " and return a freshly-allocated vector with the same length as " { $snippet "x" } " and " { $snippet "y" } " containing the result. Corresponds to the xAXPY routines in BLAS." } ;
HELP: n*V
-{ $values { "alpha" "a number" } { "x" blas-vector-base } { "alpha*x" blas-vector-base } }
+{ $values { "alpha" number } { "x" blas-vector-base } { "alpha*x" blas-vector-base } }
{ $description "Calculate the scalar-vector product " { $snippet "αx" } " and return a freshly-allocated vector with the same length as " { $snippet "x" } " containing the result. Corresponds to the xSCAL routines in BLAS." } ;
HELP: V+
! Copyright (C) 2008 John Benediktsson, Doug Coleman.
! See http://factorcode.org/license.txt for BSD license
-USING: help.markup help.syntax math ;
+USING: help.markup help.syntax math sequences ;
IN: math.finance
HELP: sma
-{ $values { "seq" "a sequence" } { "n" "number of periods" } { "newseq" "a sequence" } }
+{ $values { "seq" sequence } { "n" "number of periods" } { "newseq" sequence } }
{ $description "Returns the Simple Moving Average with the specified periodicity." } ;
HELP: ema
-{ $values { "seq" "a sequence" } { "n" "number of periods" } { "newseq" "a sequence" } }
+{ $values { "seq" sequence } { "n" "number of periods" } { "newseq" sequence } }
{ $description
"Returns the Exponential Moving Average with the specified periodicity, calculated by:\n"
{ $list
} ;
HELP: macd
-{ $values { "seq" "a sequence" } { "n1" "short number of periods" } { "n2" "long number of periods" } { "newseq" "a sequence" } }
+{ $values { "seq" sequence } { "n1" "short number of periods" } { "n2" "long number of periods" } { "newseq" sequence } }
{ $description
"Returns the Moving Average Converge of the sequence, calculated by:\n"
{ $list "MACD[t] = EMA2[t] - EMA1[t]" }
} ;
HELP: momentum
-{ $values { "seq" "a sequence" } { "n" "number of periods" } { "newseq" "a sequence" } }
+{ $values { "seq" sequence } { "n" "number of periods" } { "newseq" sequence } }
{ $description
"Returns the Momentum of the sequence, calculated by:\n"
{ $list "MOM[t] = SEQ[t] - SEQ[t-n]" }
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax math ;
IN: math.primes.lists
HELP: lprimes
{ $description "Return a sorted list containing all the prime numbers." } ;
HELP: lprimes-from
-{ $values { "n" "an integer" } { "list" "a lazy list" } }
+{ $values { "n" integer } { "list" "a lazy list" } }
{ $description "Return a sorted list containing all the prime numbers greater or equal to " { $snippet "n" } "." } ;
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax math strings ;
IN: math.text.french
HELP: number>text
-{ $values { "n" "an integer" } { "str" "a string" } }
+{ $values { "n" integer } { "str" string } }
{ $description "Return the a string describing " { $snippet "n" } " in French. Numbers with absolute value equal to or greater than 10^12 will be returned using their numeric representation." } ;
-USING: help.markup help.syntax ;
+USING: help.markup help.syntax sequences ;
IN: math.text.utils
HELP: digit-groups
-{ $values { "n" "a positive integer" } { "k" "a positive integer" } { "seq" "a sequence" } }
+{ $values { "n" "a positive integer" } { "k" "a positive integer" } { "seq" sequence } }
{ $description "Decompose a number into groups of " { $snippet "k" } " digits and return them in a sequence starting with the least significant grouped digits first." } ;
! Copyright (C) 2010 Samuel Tardieu.
! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax assocs ;
+USING: assocs help.markup help.syntax math sequences ;
IN: path-finding
{ <astar> <bfs> <dijkstra> } related-words
{ "from" "a node" }
{ "to" "a node" }
{ "astar" "an instance of a subclassed " { $link astar } " tuple" }
- { "n" "a number" }
+ { "n" number }
}
{ $description "Return the cost to go from " { $snippet "from" } " to " { $snippet "to" } ". "
{ $snippet "to" } " is necessarily a neighbour of " { $snippet "from" } "."
{ "from" "a node" }
{ "to" "a node" }
{ "astar" "an instance of a subclassed " { $link astar } " tuple" }
- { "n" "a number" }
+ { "n" number }
}
{ $description "Return the estimated (undervalued) cost to go from " { $snippet "from" } " to " { $snippet "to" } ". "
{ $snippet "from" } " and " { $snippet "to" } " are not necessarily neighbours."
HELP: considered
{ $values
{ "astar" astar }
- { "considered" "a sequence" }
+ { "considered" sequence }
}
{ $description "When called after a call to " { $link find-path } ", return a list of nodes "
"which have been examined during the A* exploration."
! Copyright (C) 2007 Chris Double.\r
! See http://factorcode.org/license.txt for BSD license.\r
-USING: help.markup help.syntax ;\r
+USING: help.markup help.syntax strings ;\r
IN: peg.javascript\r
\r
HELP: parse-javascript\r
-{ $values \r
- { "string" "a string" } \r
- { "ast" "a JavaScript abstract syntax tree" } \r
+{ $values\r
+ { "string" string }\r
+ { "ast" "a JavaScript abstract syntax tree" }\r
}\r
-{ $description \r
+{ $description\r
"Parse the input string using the JavaScript parser. Throws an error if "\r
"the string does not contain valid JavaScript. Returns the abstract syntax tree "\r
"if successful." } ;\r
! Copyright (C) 2009 Chris Double.\r
! See http://factorcode.org/license.txt for BSD license.\r
-USING: help.markup help.syntax ;\r
+USING: assocs help.markup help.syntax kernel strings ;\r
IN: s3\r
\r
HELP: buckets\r
\r
HELP: create-bucket\r
{ $values \r
- { "bucket" "a string" } \r
+ { "bucket" string } \r
}\r
{ $description \r
"Creates a bucket with the given name."\r
\r
HELP: delete-bucket\r
{ $values \r
- { "bucket" "a string" } \r
+ { "bucket" string } \r
}\r
{ $description \r
"Deletes the bucket with the given name."\r
\r
HELP: keys\r
{ $values \r
- { "bucket" "a string" } \r
+ { "bucket" string } \r
{ "seq" "a sequence of " { $link key } " objects"} \r
}\r
{ $description \r
\r
HELP: get-object\r
{ $values \r
- { "bucket" "a string" } \r
- { "key" "a string" } \r
- { "response" "The HTTP response object"} \r
- { "data" "The data returned from the http request"} \r
+ { "bucket" string }\r
+ { "key" string }\r
+ { "response" "The HTTP response object"}\r
+ { "data" "The data returned from the http request"}\r
}\r
{ $description \r
"Does an HTTP request to retrieve the object in the bucket with the given key."\r
;\r
\r
HELP: put-object\r
-{ $values \r
- { "data" "an object" } \r
- { "mime-type" "a string" } \r
- { "bucket" "a string"} \r
- { "key" "a string"} \r
- { "headers" "an assoc"} \r
+{ $values\r
+ { "data" object }\r
+ { "mime-type" string }\r
+ { "bucket" string }\r
+ { "key" string }\r
+ { "headers" assoc }\r
}\r
{ $description \r
"Stores the object under the key in the given bucket. The object has "\r
\r
HELP: delete-object\r
{ $values \r
- { "bucket" "a string"} \r
- { "key" "a string"} \r
+ { "bucket" string }\r
+ { "key" string }\r
}\r
{ $description \r
"Deletes the object in the bucket with the given key."\r
-USING: arrays help.markup help.syntax math
-sequences.private vectors strings kernel math.order layouts
-quotations generic.single ;
+USING: help.markup help.syntax math sequences ;
IN: sequences.extras
HELP: subseq*
{ $values
- { "from" "an integer" } { "to" "an integer" } { "seq" "sequence" } { "subseq" "sequence" } }
+ { "from" integer } { "to" integer } { "seq" sequence } { "subseq" sequence } }
{ $description "Outputs a new sequence using positions relative to one or both ends of the sequence. Positive values describes offsets relative to the start of the sequence, negative values relative to the end. Values of " { $link f } " for " { $snippet "from" } " indicate the beginning of the sequence, while an " { $link f } " for " { $snippet "to" } " indicates the end of the sequence." }
{ $notes "Both " { $snippet "from" } " and " { $snippet "to" } " can be safely set to values outside the length of the sequence. Also, " { $snippet "from" } " can safely reference a smaller or greater index position than " { $snippet "to" } "." }
{ $examples
IN: splitting.extras
HELP: split*-when
-{ $values { "seq" "a sequence" } { "quot" { $quotation ( ... elt -- ... ? ) } } { "pieces" "a new array" } }
+{ $values { "seq" sequence } { "quot" { $quotation ( ... elt -- ... ? ) } } { "pieces" "a new array" } }
{ $description "A variant of " { $link split-when } " that includes the elements along which the sequence was split." }
{ $examples { $example "USING: ascii kernel prettyprint splitting.extras ;" "\"hello,world-how.are:you\" [ letter? not ] split*-when ." "{ \"hello\" \",\" \"world\" \"-\" \"how\" \".\" \"are\" \":\" \"you\" }" } } ;
HELP: split*
-{ $values { "seq" "a sequence" } { "separators" "a sequence" } { "pieces" "a new array" } }
+{ $values { "seq" sequence } { "separators" sequence } { "pieces" "a new array" } }
{ $description "A variant of " { $link split } " that includes the elements along which the sequence was split." }
{ $examples { $example "USING: prettyprint splitting.extras ;" "\"hello world-how are you?\" \" -\" split* ." "{ \"hello\" \" \" \"world\" \"-\" \"how\" \" \" \"are\" \" \" \"you?\" }" } } ;
HELP: split-find
-{ $values { "seq" "a sequence" } { "quot" { $quotation ( seq -- i ) } } { "pieces" "a new array" } }
+{ $values { "seq" sequence } { "quot" { $quotation ( seq -- i ) } } { "pieces" "a new array" } }
{ $description "Splits a sequence into slices using the provided quotation to find split points." } ;
projects / factor.git / commitdiff