浏览代码

Add new documentation file that we should write for primitives

Yentl Van Tendeloo 8 年之前
父节点
当前提交
0385a07b1e
共有 1 个文件被更改,包括 26 次插入0 次删除
  1. 26 0
      doc/primitives.rst

+ 26 - 0
doc/primitives.rst

@@ -0,0 +1,26 @@
+Functions
+=========
+
+Explain the different types of functions in the Modelverse.
+
+Primitive functions
+-------------------
+
+Explain primitive functions:
+hardcoded in kernel, no AL equivalent
+minimal set of functions to be ported for new kernel
+
+Compiled functions
+------------------
+
+Explain compiled functions:
+hardcoded in kernel, but AL equivalent
+can be ported for efficiency fo the resulting kernel, but not required
+
+Normal functions
+----------------
+
+Explain normal functions:
+completely in AL, no compiled equivalent
+can still be implemented by kernel as compiled for performance, though not required
+functions are likely to be flexible