Project

Namespaces

Public Vars

example.example

This namespace includes all features exposed by metadoc library.

What’s in:

  • Code snippets
  • Examples
  • Tests from examples
  • Constants
  • Categorization

All examples are inline.

Categories

Constants

Code snippets

Calculate integral value of some 2d function in ranges (0, PI). This is example of the snippet.

(defn integral-snippet
  [f params & opts]
  (let [step 0.01
        area (* step step)
        r (range 0 pi step)]
    (reduce (fn [curr [x y]] (+ curr (* area (f x y))))
            0
            (for [x r y r] [x y]))))

Draws function values and saves to file.

(defn draw-trig
  [f params & opts]
  (let [unique-name (str (first opts) ".png")
        canvas (BufferedImage. 200 200 BufferedImage/TYPE_INT_RGB)
        graphics (.createGraphics canvas)
        rect (Rectangle2D$Double.)
        file (io/file (str "docs/" unique-name))]
    (doto graphics
     (.setBackground (Color. (int 48) (int 66) (int 106)))
     (.clearRect 0 0 200 200)
     (.setColor Color/white))
    (dotimes [x 200]
      (let [res (f (/ x 40.0))
            y (- 200 (+ 10 (* 90.0 (inc res))))]
        (.setFrame rect x y 2.5 2.5)
        (.fill graphics rect)))
    (when-let [txt (first params)] (.drawString graphics txt 10 185))
    (.dispose graphics)
    (ImageIO/write canvas "png" file)
    unique-name))

cos-x-cos-y

(cos-x-cos-y x y)

Calculates cos(x) * cos(y).

Examples

Let’s calculate some values

(cos-x-cos-y 1.0 2.0)
;;=> -0.2248450953661529
(cos-x-cos-y 0.0 0.0)
;;=> 1.0
(cos-x-cos-y pi pi)
;;=> 1.0

;; Test: ok.

Plot of the function. Taken from WolframAlpha.

Calculate integral

(integral-snippet cos-x-cos-y ...)
;;=> 2.5365212358036414E-6
view source

custom-example

(custom-example t)

Return custom example map with t as example value.

Examples

Custom Example value

(custom-example "nothing")
;;=> {:doc "Example documentation", :example "nothing", :type :custom}
view source

drawing-snippet-examples

(drawing-snippet-examples x)

Draw some trig functions. Using example-snippet with result dispatched to :image type.

Examples

SIN

(draw-trig (fn [x] (Math/sin x)) "sin" ...)

COS

(draw-trig (fn [x] (Math/cos x)) "cos" ...)

TAN

(draw-trig (fn [x] (Math/tan x)) "tan" ...)

This function

(draw-trig drawing-snippet-examples ...)
view source

examples-with-tests

(examples-with-tests)

This function has examples with tests.

Examples

Testing against 121. Should be ok.

(* 11 11)
;;=> 121

;; Test: ok.

Also testing against 121. Should fail.

(* 11 10)
;;=> 110

;; Test: failed, expected value(s): 121.

Testing session with test. Should pass.

(* 11 11)
;;=> 121
(inc (* 11 11))
;;=> 122

;; Test: ok.

Testing session with test. Should fail.

(* 11 10)
;;=> 110
(inc (* 11 11))
;;=> 122

;; Test: failed, expected value(s): [121 122].
view source

function-in-some-category

(function-in-some-category x)

Returns negative value od parameter x. This is function without examples.

view source

function-with-custom-example

(function-with-custom-example)

Dummy function with custom example.

Examples

Example documentation

Here is text of the example.
view source

pi

const

;;=> 3.141592653589793

Just PI value.

view source

sin-x-sin-y

(sin-x-sin-y x y)

Calculates sin(x) * sin(y).

Examples

Let’s check result.

(sin-x-sin-y 1.0 2.0)
;;=> 0.7651474012342926

List of calls. Do not evaluate

false
;;=> false
(sin-x-sin-y 1.0 2.0)
;;=> 0.7651474012342926
(sin-x-sin-y 0.0 0.0)
;;=> 0.0
(sin-x-sin-y pi pi)
;;=> 1.4997597826618576E-32

Do not evaluate, but test against 0.0.

(sin-x-sin-y 0.0 0.0)
;;=> 0.0

;; Test: ok.

Calculate integral of [0,pi]x[0,pi] range.

(integral-snippet sin-x-sin-y ...)
;;=> 3.999960113332432

Check integral value on WolframAlpha

view source

some-text

const

;;=> This is example text
view source