Documentation
¶
Overview ¶
Package node reads the node directories of tamnd/algorithm (spec 04.3 and 04.4).
Index ¶
- Variables
- func IsKind(k string) bool
- func IsTestFile(name string) bool
- func SplitFront(b []byte) (front, body []byte, bodyLine int, err error)
- type Area
- type Complexity
- type Corpus
- type File
- type Front
- type History
- type Impl
- type Lang
- type LangTool
- type Node
- type Preset
- type Proof
- type ProofFront
- type Solve
- type Source
- type Tag
Constants ¶
This section is empty.
Variables ¶
var Kinds = []string{
"area", "concept", "definition", "model", "problem", "abstract-type",
"algorithm", "data-structure", "technique", "theorem", "exercise", "person",
}
Kinds are the 12 node kinds of spec 04.1.
var Levels = []string{"intro", "core", "advanced", "research"}
Levels are the editorial levels of spec 05.5.
Functions ¶
func IsTestFile ¶
IsTestFile tells if a file name is a native test, by the conventions of spec 08.3. Examples: test_binary_search.py, binary_search_test.go, binarySearch.test.js, BinarySearchTest.java, binary_search_tests.rs.
Types ¶
type Area ¶
type Area struct {
ID string `yaml:"id" json:"id"`
Name string `yaml:"name" json:"name"`
Summary string `yaml:"summary,omitempty" json:"summary,omitempty"`
Children []Area `yaml:"children,omitempty" json:"children,omitempty"`
Parent string `yaml:"-" json:"parent,omitempty"`
}
Area is one entry of topics/areas.yaml (spec 05.2).
type Complexity ¶
type Complexity struct {
Vars map[string]string `yaml:"vars,omitempty" json:"vars,omitempty"`
Time map[string]string `yaml:"time,omitempty" json:"time,omitempty"`
Space map[string]string `yaml:"space,omitempty" json:"space,omitempty"`
Other map[string]map[string]string `yaml:",inline" json:"other,omitempty"`
}
Complexity holds the claims of a node (spec 04.4 and 06.6).
type Corpus ¶
type Corpus struct {
Root string
Nodes []*Node
BySlug map[string]*Node
ByTag map[string]*Node
Areas []Area
AreaByID map[string]*Area // keyed by Area.Path()
Langs []Lang
LangByID map[string]*Lang
Reserved map[string]bool
Tags []Tag
// Errors are the node directories that could not be read. Package check reports them as T01.
Errors []error
}
Corpus is the content tree.
type File ¶
type File struct {
Name string `json:"name"`
Path string `json:"path"`
Content string `json:"-"`
Test bool `json:"test"`
}
File is one file of an implementation.
type Front ¶
type Front struct {
Tag string `yaml:"tag" json:"tag"`
Kind string `yaml:"kind" json:"kind"`
Slug string `yaml:"slug" json:"slug"`
Name string `yaml:"name" json:"name"`
Aliases []string `yaml:"aliases,omitempty" json:"aliases,omitempty"`
Area string `yaml:"area" json:"area"`
Areas []string `yaml:"areas,omitempty" json:"areas,omitempty"`
Level string `yaml:"level" json:"level"`
Summary string `yaml:"summary" json:"summary"`
Solves []Solve `yaml:"solves,omitempty" json:"solves,omitempty"`
Implements []string `yaml:"implements,omitempty" json:"implements,omitempty"`
Techniques []string `yaml:"techniques,omitempty" json:"techniques,omitempty"`
Uses []string `yaml:"uses,omitempty" json:"uses,omitempty"`
VariantOf string `yaml:"variant_of,omitempty" json:"variant_of,omitempty"`
Generalizes []string `yaml:"generalizes,omitempty" json:"generalizes,omitempty"`
Model string `yaml:"model,omitempty" json:"model,omitempty"`
Complexity *Complexity `yaml:"complexity,omitempty" json:"complexity,omitempty"`
Properties map[string]any `yaml:"properties,omitempty" json:"properties,omitempty"`
Constraints map[string]any `yaml:"constraints,omitempty" json:"constraints,omitempty"`
History *History `yaml:"history,omitempty" json:"history,omitempty"`
Prereqs []string `yaml:"prereqs,omitempty" json:"prereqs,omitempty"`
SameAs map[string]any `yaml:"same_as,omitempty" json:"same_as,omitempty"`
Lean map[string]string `yaml:"lean,omitempty" json:"lean,omitempty"`
Sources []Source `yaml:"sources,omitempty" json:"sources,omitempty"`
Exercises []string `yaml:"exercises,omitempty" json:"exercises,omitempty"`
People []string `yaml:"people,omitempty" json:"people,omitempty"`
SeeAlso []string `yaml:"see_also,omitempty" json:"see_also,omitempty"`
}
Front is the front matter of node.md. The schema is schema/node.v1.json in tamnd/algorithm.
type History ¶
type History struct {
Year int `yaml:"year,omitempty" json:"year,omitempty"`
People []string `yaml:"people,omitempty" json:"people,omitempty"`
Note string `yaml:"note,omitempty" json:"note,omitempty"`
}
History says where a node comes from.
type Impl ¶
Impl is the implementation of a node in one language (spec 08.1).
type Lang ¶
type Lang struct {
ID string `yaml:"id" json:"id"`
Name string `yaml:"name" json:"name"`
Tier int `yaml:"tier" json:"tier"`
Ext []string `yaml:"ext" json:"ext"`
FileCase string `yaml:"file_case" json:"file_case,omitempty"`
Test LangTool `yaml:"test" json:"test"`
Format LangTool `yaml:"format" json:"format"`
Lint LangTool `yaml:"lint" json:"lint"`
Toolchain string `yaml:"toolchain" json:"toolchain,omitempty"` // the pinned version, for the language page
Run string `yaml:"run" json:"run,omitempty"` // how a reader runs the tests without algo
Comment string `yaml:"comment" json:"comment,omitempty"`
Highlight string `yaml:"highlight" json:"highlight"` // the Chroma lexer
Int string `yaml:"int" json:"int,omitempty"`
List string `yaml:"list" json:"list,omitempty"`
Since string `yaml:"since" json:"since,omitempty"`
}
Lang is one entry of registers/languages.yaml (spec 08.2).
type LangTool ¶
type LangTool struct {
Tool string `yaml:"tool,omitempty" json:"tool,omitempty"`
Framework string `yaml:"framework,omitempty" json:"framework,omitempty"`
File string `yaml:"file,omitempty" json:"file,omitempty"`
Args []string `yaml:"args,omitempty" json:"args,omitempty"`
}
LangTool is a tool of a language: the test framework, the formatter or the linter.
type Node ¶
type Node struct {
Front
Body string `json:"-"`
BodyLine int `json:"-"` // the line of node.md where the body starts
Dir string `json:"-"`
Rel string `json:"path"` // the directory, relative to the root
RawFront []byte `json:"-"`
Forbidden []string `json:"-"` // front matter keys that rule T05 rejects
Impls []Impl `json:"impls,omitempty"`
Proofs []Proof `json:"proofs,omitempty"`
Scene string `json:"scene,omitempty"` // path of viz/scene.ts, relative to the root
Presets []Preset `json:"presets,omitempty"`
}
Node is one node directory.
type Preset ¶
type Preset struct {
Name string `yaml:"name" json:"name"`
Input map[string]any `yaml:"input" json:"input"`
Note string `yaml:"note,omitempty" json:"note,omitempty"`
}
Preset is a named input of a scene (spec 10.4).
type Proof ¶
type Proof struct {
ID string `json:"id"`
Path string `json:"path"`
Front ProofFront `json:"front"`
Body string `json:"-"`
}
Proof is one file of proofs/.
type ProofFront ¶
type ProofFront struct {
Title string `yaml:"title" json:"title"`
Proves []string `yaml:"proves" json:"proves"`
Status string `yaml:"status" json:"status"` // full or sketch
Lean string `yaml:"lean,omitempty" json:"lean,omitempty"`
}
ProofFront is the front matter of a proof file (spec 06.5).
type Solve ¶
type Solve struct {
Problem string `yaml:"problem" json:"problem"`
Requires map[string]any `yaml:"requires,omitempty" json:"requires,omitempty"`
Time string `yaml:"time,omitempty" json:"time,omitempty"`
Note string `yaml:"note,omitempty" json:"note,omitempty"`
}
Solve is one `solves` edge. The short form is a problem slug. The long form has conditions (spec 04.4).
type Source ¶
type Source struct {
Book string `yaml:"book,omitempty" json:"book,omitempty"`
URL string `yaml:"url,omitempty" json:"url,omitempty"`
Paper string `yaml:"paper,omitempty" json:"paper,omitempty"`
Title string `yaml:"title,omitempty" json:"title,omitempty"`
Locator string `yaml:"locator,omitempty" json:"locator,omitempty"`
Note string `yaml:"note,omitempty" json:"note,omitempty"`
}
Source is one entry of `sources`.