About This Page
I don't like reading thick O'Reilly books when I start learning new programming languages. Rather, I like starting by writing small and dirty code. If you take this approach, having many simple code examples are extremely helpful because I can find answers to these questions very easily.
How can I define a function?
What's the syntax for if and else?
Does the language support string interpolation?
What scopes of variables are available?
These are very basic questions, but enough to start hacking with the new languages.
Recently, I needed to learn this completely new language Clojure but couldn't find what I wanted. So, I decided to create one while learning Clojure.
Clojure is a functional programming language and learning functional programming languages is sometimes hard if you've only had experiences with imperative languages. I have paid careful attention to make this page easy to understand for people who don't have experiences with functional programming languages, so please don't hesitate to read this page even if you don't know anything about functional programming.
Hopefully, this page helps you learning functional programming and starting to write Clojure!
Hello, world!
user=> (println "Hello, world!")
Hello, world!
nil
user> "h"
"h"
user> 100
100
user> true
true
Our first Clojure code is, of course, printing "Hello, world!". Here, we invoke the function println with the argument Hello, world!. We call the invocation of function applying the function to data in Clojure or other functional programming language.
The entire line of the code (....) is called a form in Clojure. It's also called expression in a general sense, but there is no real problem to use them interchangeably.
You can think of form as something that returns a value. "h" 100 true are all forms as well.
Bindings
Giving names to values is called assignment in many programming languages. However, we call the mapping between names and values binding in Clojure.
Symbol
Symbols are used to bind names to values. a b my-cool-function nyncat: they are all symbols in Clojure.
user> (type 'a)
clojure.lang.Symbol
user> (type 'b)
clojure.lang.Symbol
user> (type 'my-cool-function)
clojure.lang.Symbol
user> (type 'nyncat)
clojure.lang.Symbol
' will prevent a form from being evaluated. We are doing this here because we want to treat symbols as data in order to pass them to type function.
user> (def a "aaaaa")
#'user/a
user> (println a)
aaaaa
nil
user> (println b)
CompilerException java.lang.RuntimeException: Unable to resolve symbol: b in this context, compiling:(NO_SOURCE_PATH:1:1)
If you don't prepend a ' single quote, you are telling Clojure to resolve the symbol. You can obtain bound values by resolving symbols.
When we try to resolve symbols that are not bound to anything, Clojure complains with the exception.
Let
user=> (let [l "light"] (println (str "God said let there be " l)))
God said let there be light
nil
To bind values to names, use let. Let takes a vector which takes a symbol in the first element and a value in the second element.
user=> (println l)
CompilerException java.lang.RuntimeException: Unable to resolve symbol: l in this context, compiling:(NO_SOURCE_PATH:1:1)
You cannot resolve the symbol outside the let. This behavior is very similar to private variable in other programming languages.
user=> (let [l "light"
d "darkness"]
(println (str "God said let there be " l))
(println (str "God also said let there be " d)))
God said let there be light
God also said let there be darkness
nil
You can also provide multiple bindings.
user> (let [l "light"
l_d (str l " and" " darkness")]
(println (str "God also said let there be " l_d)))
God also said let there be light and darkness
nil
The binding will be immediately available, so each binding can see the prior bindings.
Scope
When Clojure tries to resolve a symbol, the resolution will be done in the scope of the symbol.
user> (let [a "aaa"]
(println a))
aaa
nil
Clojure tries to evaluate a because it needs to pass the value to println. a is bound to "aaa", so "aaa" is printed in your terminal. Very straight forward.
user> (let [a "aaa"]
(let [a "AAA"]
(println a)))
AAA
nil
Now, let are nested. Like previous example, Clojure tries to resolve a. However, this time Clojure resolves a to "AAA", instead of aaa. Each let will create a scope and symbol resolution is done inside the let where the symbol is resolved.
user> (let [a "aaa"]
(let [a "AAA"]
(println a))
(println a))
AAA
aaa
nil
Also notice that the inner let does not override the scope of outer let.
This kind of scope is called lexical scope. For those whom English is not your first language, lexical means words in a sentence. The scope is lexical because the compiler relies on the physical location of the symbol (word) in a program (sentence) to resolve them.
user> (let [a "a"]
(let []
(println a)))
a
nil
The resolution look up bubbles up until it finds the binding. The inner let doesn't provide the binding for a, so it bubbles up to the outer let. This happens because the scope of inner let is wrapped by the scope of outer let.
user> (let [a "a"]
(let []
(println not-bound-symbol)))
CompilerException java.lang.RuntimeException: Unable to resolve symbol: not-bound-symbol in this context, compiling:(NO_SOURCE_PATH:3:11)
Clojure complains with Unable to resolve symbol exception when it cannot find the binding inside the given scope.
You probably find the idea of lexical scope very familiar. This is because most modern programming languages use lexical scope. There is also something called dynamic scope but you probably don't have to know that right now.
Def
user=> (def object "light")
#'user/object
user=> (println (str "God said let there be " object))
God said let there be light
nil
You can also bind symbols to values with def. While you can access the symbol only from within the let where it's declared , you can access the symbol declared with def from anywhere.
user=> (def object "darkness")
#'user/object
user=> (println (str "God said let there be " object))
God said let there be darkness
nil
You can also override the one already declared later.
The rule of thumb in Clojure is avoiding the use of def as much as possible. def introduces state and abusing state will make our code difficult to maintain.
Functions
Defn
user=> (defn say-hello
[name]
(println (str "Hello, " name)))
user=> (say-hello "Kim")
Hello, Kim
nil
To define a function, use defn.
The first argument is the name of function say-hello, the second argument is the argument of the function [name], and the third argument is the function body (println (str "Hello, " name)).
user=> (defn say-hello
"Takes name argument and say hello to the name"
[name]
(println (str "Hello, " name)))
You can also add documentation.
user=> (doc say-hello)
-------------------------
user/say-hello
([name])
Takes name argument and say hello to the name
nil
Use doc to read the documentation.
user=> (defn say-hello
"Takes name argument and say hello to the name"
{:added "1.0"
:static true}
[name]
(println (str "Hello, " name)))
You can also add metadata of the function.
user=> (meta (var say-hello))
{:added "1.0", :ns #<Namespace user>, :name say-hello, :file "NO_SOURCE_PATH", :static true, :column 1, :line 1, :arglists ([name]), :doc "Takes name argument and say hello to the name"}
You can expand the metadata with meta. Notice that say-hello is first passed to var. This is because meta expects it's argument to be var object, not value, and var will turn the passed symbol into var object.
user> (meta #'say-hello)
{:added "1.0", :ns #<Namespace user>, :name say-hello, :file "NO_SOURCE_PATH", :static true, :column 1, :line 1, :arglists ([name]), :doc "Takes name argument and say hello to the name"}
#' is the reader macro for var and works the exactly same.
Anonymous Function
Functions are first class objects in Clojure. When you say something is a first class object in programming language X, it means that you can do all the basic operations with the object such as passing it to a function, returned from a function, and binding it to a variable, etc.
user=> (fn [] (println "Hello world"))
#<user$eval3663$fn__3664 user$eval3663$fn__3664@5de5bfa4>
To create a function object, use fn.
user=> (def hello-world-func (fn [] (println "Hello world")))
#'user/hello-world-func
user=> (hello-world-func)
Hello world
nil
You can bind functions to var just like other values. This works just like defn
user=> #(+ 1 1)
#<user$eval2902$fn__2903 user$eval2902$fn__2903@1cc9a623>
user=> (fn [] (+ 1 1))
#<user$eval2920$fn__2921 user$eval2920$fn__2921@40bd9db>
#() is the shortcut for fn.
user=> #(+ 1 %)
#<user$eval2930$fn__2931 user$eval2930$fn__2931@3e445ad7>
user=> (let [plus #(+ 1 %)]
(plus 10))
11
user=> (let [plus-numbers #(+ 1 %1 %2 %3)]
(plus-numbers 10 20 30))
61
% will be replaced with arguments passed to the function. When the function takes multiple arguments, %1 is for the first argument, %2 is for the second and so on.
user=> (def say-hello (fn [name] (println (str "Hello, " name))))
#'user/say-hello
user=> (def say-bye (fn [name] (println (str "Good bye, " name))))
#'user/say-bye
user=> (def greeting (fn [greeting-func name] (greeting-func name)))
#'user/greeting-to-kim
user=> (greeting say-hello "Kim")
Hello, Kim
nil
user=> (greeting say-bye "Kim")
Good bye, Kim
nil
You can also pass a function to another function. We define two functions and bind to say-hello and say-bye vars. We also define a generic function and bind to greeting.
Then we pass say-hello and say-bye to greeting.
Closure
When a function (let's call this inner function) is returned from another function (let's call this outer function), and the inner function does somethings with the arguments given from outer function, then the inner function is called a closure.
user=> (defn inner
[from-outer]
(fn [] (println from-outer)))
#'user/inner
user=> (def outer1 (inner "this is from outer"))
#'user/outer1
user=> (def outer2 (inner "this is yet another from outer"))
#'user/outer2
user=> (outer1)
this is from outer
nil
user=> (outer2)
this is yet another from outer
nil
We define a function called inner. inner function prints from-outer var which is supposed to be given by the outer function.
We also define two functions, outer1 and outer2. These functions both call inner but with different arguments.
As a result, even if the from-outer var doesn't change, inner prints different things.
Namespaces
Namespace provides a way to organize different Clojure objects into to logical groups. These logical groups often are called library and can be used from other namespaces. A namespace is constructed of symbols chained by .. clojure.core, clojure-http.client, my.app.example: they are all namespaces.
Create-ns
user> (create-ns 'clojure.by.example)
nil
To create a namespace, use create-ns. However, it is rare to create a namespace with create-ns because there is more handy ns macro which will be explained later. You need to place a single quote before a namespace in order to stop resolving the namespace symbol. See Quotes for more details about quoting.
In-ns
clojure.by.example> (in-ns 'user)
#object[clojure.lang.Namespace 0x2522a678 "user"]
user>
To move to a specific namespace, use in-ns.
Require
One of the important roles of namespace is providing a scope for Clojure objects.
clojure.by.example> (defn favorite-language [] "Clojure!!")
#'clojure.by.example/favorite-language
clojure.by.example> (favorite-language)
"Clojure!!"
clojure.by.example> (in-ns 'user)
#object[clojure.lang.Namespace 0x2522a678 "user"]
user> (favorite-language)
CompilerException java.lang.RuntimeException: Unable to resolve symbol: favorite-language in this context, compiling:(*cider-repl localhost*:501:7)
Things that you define in a namespace is not visible from other namespaces by default. As you can see in this example, favorite-language function is not visible from user namespace.
user> (require 'clojure.by.example)
nil
user> (clojure.by.example/favorite-language)
"Clojure!!"
To load other namespaces, use require. Once you load clojure.by.example namespace, favorite-language will be available from user namespace.
user> (require '[clojure.by.example :as cbe])
nil
user> (cbe/favorite-language)
"Clojure!!"
Sometimes you want to give a different name to a loaded namespace. In such a case, you can surround the namespace by a vector with :as keyword.
user> (require '[clojure.by.example :as cbe]
'[clojure.core :as ccc])
nil
You can also require multiple namespaces at once.
Refer
user> (refer 'clojure.by.example)
nil
user> (favorite-language)
"Clojure!!"
You probably don't want to type clojure.by.example everytime you want to call favorite-language function. You can avoid this if you use refer.
Use
user> (use 'clojure.by.example)
nil
user> (favorite-language)
"Clojure!!"
require loads a namespace and refer refers the namespace. To do these at once, you can use use.
Import
user> (import java.util.Date)
java.util.Date
user> (new Date)
#inst "2017-01-15T14:32:18.537-00:00"
To import a namespace of Java, you need to use import. Please see Java section for more information about how to use Java.
Ns
ns macro creates a new namespace and gives you an opportunity to load other namespaces at the creation time.
(ns example.namespace
(:require [clojure.java.io])
(:use [clojure.data])
(:import [java.util List Set]))
ns can take :require, :use, and :import keyword. They work the same way as the corresponding functions explained above except you don't need to quote.
Control Flow
If
user=> (if true
(println "This is always printed")
(println "This is never printed"))
This is always printed
nil
if takes a predicate (true or false) as the first argument. The second argument will be evaluated if the predicate is evaluated to true. The third argument is equivalent to else in many programming languages which is evaluated when the predicate evaluates to false.
user=> (if true
(do
(println "one")
(println "two")))
one
two
nil
In Clojure, you can only pass one expression to a branch of if. However, you often need to pass more than one expression in real programs. In this case, use do.
If-Let
user=> (defn positive-number [numbers]
(if-let [pos-nums (not-empty (filter pos? numbers))]
pos-nums
"no positive numbers"))
user=> (positive-number [-1 -2 1 2])
(1 2)
user=> (positive-number-seq [-1 -2])
"no positive numbers"
After testing condition, you often want to use the result of the testing later. if-let binds the evaluated condition to var when it's truthy. In this example, when positive-number receives a collection which contains positive numbers, the result of (not-empty (filter pos? numbers)) will be bound to pos-nums.
pos-nums is returned since the collection contains positive numbers 1 2.
The second argument is for else branch. It will be evaluated when the first argument is evaluated to be false.
user=> (boolean (filter pos? [-1]))
true
user=> (not-empty [1 2])
[1 2]
user=> (not-empty [])
nil
Note that filter returns an empty sequence when no value matches the condition instead of nil and an empty sequence is not falsey in Clojure. But, in order to reach the else branch of if-let, pos-nums has to be nil. For this reason, we are using not-empty which properly returns nil if the sequence is empty.
When
user=> (when true
(println "one")
(println "two"))
one
two
nil
When you only care about the case when the condition is truthy, you can use when. when is similar to if but does not contain an else branch and is already wrapped by do, so you can pass multiple expressions.
user=> (when false
(println "one")
(println "two"))
nil
Since there is no else branch, this doesn't do anything.
When-Let
user=> (when-let [pos-nums (filter pos? [ -1 -2 1 2])]
pos-nums
(println "one")
(println "two"))
one
two
nil
There is also when-let which is similar to if-let but does not contain an else branch.
Case
user=> (defn case-test-1
[n]
(case n
1 "n is 1"
2 "n is 2"
"n is other"))
#'user/case-test-1
user=> (println (case-test-1 1))
n is 1
nil
user=> (println (case-test-1 2))
n is 2
nil
user=> (println (case-test-1 3))
n is other
nil
There is also case which works pretty much the same as the one in other programming languages. case compares the value with each condition with =
and evaluates the expression in the matched branch.
The expression in the last branch will be evaluated if none of the conditions are matched.
Cond
user=> (defn cond-test
[n]
(cond
(= n 1) "n is 1"
(and (> n 3) (< n 10)) "n is over 3 and under 10"
:else "n is other"))
user=> (println (cond-test 1))
n is 1
nil
user=> (println (cond-test 5))
n is over 3 and under 10
nil
user=> (println (cond-test 15))
n is other
nil
When you want to do similar thing to case but want to write your own test case rather than =, you can use cond. You can write a different test case in each branch with cond.
You use :else keyword for the default case.
Condp
user=> (defn condp-test-2
[n]
(condp contains? n
#{1 2 3} "n is either 1 or 2 or 3"
"n is not 1 or 2 or 3"))
#'user/condp-test-2
user=> (println (condp-test-2 2))
n is either 1 or 2 or 3
nil
user=> (println (condp-test-2 5))
n is not 1 or 2 or 3
nil
You can use a predicate with condp for condition. In this case contains? is the predicate.
(contains? #{1 2 3} 2) will be evaluated in this case.
(contains? #{1 2 3} 5) will be evaluated falsey, thus the default branch will be evaluated.
Boolean
user=> true
true
user=> false
false
true and false are values of Boolean type just like in other programming languages.
user> (boolean false)
false
user> (boolean nil)
false
user> (boolean 0)
true
user> (boolean 1)
true
user> (boolean "hi there")
true
user> (boolean :hi)
true
In Clojure, everything except false and nil are true.
Strings
Literal
user=> "Hi, there!"
"Hi, there!"
You can create a string by double-quoting text.
Str
user=> (str "Good " "morning")
"Good morning"
To concatenate strings, use str.
user=> (+ "Good " "morning")
ClassCastException java.lang.String cannot be cast to java.lang.Number clojure.lang.Numbers.add (Numbers.java:126)
+ operator doesn't work to concat strings against your expectation.
user> (let [first "Hirokuni"
last "Kim"]
(str "My name is " first " " last))
"My name is Hirokuni Kim"
Clojure doesn't have string interpolation. str works for you.
Format
user=> (format "My name is %s %s" "Hirokuni" "Kim")
"My name is Hirokuni Kim"
Like many other languages, Clojure supports string formatting with format function. The concat example above can also be achieved by using format function.
The first argument tells format function the format you want to apply to your strings. %s is called format specifier and it specifies the type of data to be formatted. The rest of arguments will replace format specifiers.
user=> (format "My favorite fruit is %s" "apple")
"My favorite fruit is apple"
%s is a format specifier for string.
user=> (format "I ate %d apples" 2)
"I ate 2 apples"
%d is a format specifier for integer.
user=> (format "Pi: %.3f" 3.14159265)
"Pi: 3.142"
user=> (format "Pi: %.5f" 3.14159265)
"Pi: 3.14159"
%.Nf is a format specifier for floating numbers where N specifies how floating points to print.
user=> (format "Boolean representation of 1: %b" 1)
"Boolean representation of 1: true"
user=> (format "Boolean representation of nil: %b" nil)
"Boolean representation of nil: false"
%b is a format specifier for boolean.
Integers
Addition
user=> (+ 2 3)
5
Subtraction
user=> (- 10 3)
7
Multiplication
user=> (* 10 2)
20
Division
user=> (/ 4 2)
2
user=> (/ 4 3)
4/3
Interesting thing is that fractions are represented by ratio.
Modulo
user=> (mod 3 2)
1
Get modulus with mod
Max
user=> (max 1 2 3 4 5)
5
Get the greatest number with max.
Min
user=> (min 5 4 3 2 1)
1
Get the smallest number with min.
Power
user=> (defn power
[x n]
(reduce * (repeat n x))
)
user=> (power 2 3)
8
Clojure doesn't provide built-in function for exponential operation.
Define a function power. reduce takes a sequence generated by repeat and compute * against each element of the sequence and returns the sum. The sum is used to do * against the next element of the sequence.
Bigint
user=> (+ (bigint Long/MAX_VALUE) 10)
9223372036854775817N
You can use bigint to handle really big numbers.
user> (+ 9223372036854775807 10)
ArithmeticException integer overflow clojure.lang.Numbers.throwIntOverflow (Numbers.java:1501)
user> (+ 9223372036854775807N 10N)
9223372036854775817N
N is a literal for bigint.
Lists
Lists are the most basic collection in Clojure which is a dialect of Lisp (List Processing language). However, you don't often use list as data collection because you have more useful collection data types in Clojure such as vectors or maps.
Literal
user=> '(1 2 3)
(1 2 3)
A list is a simple collection of values. You can create a list by grouping values with parentheses and a single quote ' at the beginning.
user> (1 2 3)
ClassCastException java.lang.Long cannot be cast to clojure.lang.IFn user/eval2843 (NO_SOURCE_FILE:1)
We need ' to prevent the list from being evaluated.
Conj
user=> (conj '(1 2 3) 4)
(4 1 2 3)
To add a value to the list, use conj (conj[oin]). Note that the new value is added to the top.
How can I remove elements?
You may wonder: How can I remove an element at a specific position from a list? How can I remove all elements that match in a list?
Unfortunately, there is no built-in function that do these removal operations in lists. You can still use functions from the seq library such as remove, filter, or drop.
If you are not familiar with the seq library, jump to Sequences to learn more!
Nth
user=> (nth '(1 2 3) 1)
2
To get a value from the list, use nth with it's index number. Index starts from 0
Count
user=> (count '(1 2 3) )
3
To count how many values are in a list, use count.
Vectors
You can think of vectors as a more efficient and useful version of lists. It's more practical to store multiple values in a vector.
Literal
user=> [1 2 3]
[1 2 3]
You can create a vector by grouping values with square brackets. Unlike lists, you don't need ' because vectors will not be evaluated.
Conj
user=> (conj [1 2 3] 4)
[1 2 3 4]
To add a value, use conj (conj[oin]). Note that the new value is added to the end while it is added to the beginning in lists.
How can I remove elements?
The same story as lists.
Nth
user=> (nth [1 2 3] 1)
2
To get a value from the vector, you need to specify the index of the value.
user=> (first [1 2 3])
1
user=> (last [1 2 3])
3
Vectors have convenient functions to access elements. To get the first and second elements, use first and second.
.indexOf
user=> (.indexOf [1 2 3] 2)
1
You can get the index of a value with .indexOf. The dot before indexOf indicates Java interop to access methods in Java.
user=> (.indexOf [1 2 3] 4)
-1
Returns -1 if the value doesn't exist.
Sets
Sets are collections of unique values. In other words, you cannot have duplicated values in a set.
Another important trait of sets is that the order of values is not guaranteed.
Literal
user=> #{1 2 3}
#{1 3 2}
You can create a set by grouping values with #{}. Notice the order of the values is not maintained.
user=> #{1 2 3 3}
IllegalArgumentException Duplicate key: 3 clojure.lang.PersistentHashSet.createWithCheck (PersistentHashSet.java:68)
You will get an exception when you try to store duplicated value. In this case, 3 is duplicated value.
Conj
user=> (conj #{1 2 3} 4)
#{1 4 3 2}
To add a value, use conj (conj[oin]).
user=> (conj (conj #{1 2 3} 4) 4)
#{1 4 3 2}
Because sets doesn't allow duplicated values, you will see only one 4 in the final set.
Disj
user=> (disj #{1 2 3} 1)
#{3 2}
To create a set where a value is removed (basically removing a value from set), use disj (disj[oin]).
user=> (disj #{1 2 3} 4)
#{1 3 2}
If trying to disj a value that doesn't exist in the set, it returns the original set.
Sort
user=> (sort (conj #{1 2 3} 4))
(1 2 3 4)
Sets are unordered collections of values, meaning that the order of values is not guaranteed. To get a sorted order, use sort.
Contains?
user=> (contains? #{1 2 3} 1)
true
user=> (contains? #{1 2 3} 4)
false
To check if a value is contained in the set, use contains?.
Subset?
user=> (clojure.set/subset? #{1 2} #{1 2 3 4})
true
user=> (clojure.set/subset? #{1 5} #{1 2 3 4})
false
To check if a set is the part of another set, use subset?.
Superset?
user=> (clojure.set/superset? #{1 2 3} #{1 2})
true
To check if a set includes another set, use superset?.
Maps
Maps are key-value data structure to store multiple values.
Literal
user=> {:Apple "Mac" :Microsoft "Windows"}
{:Apple "Mac", :Microsoft "Windows"}
user=> {"Apple" "Mac" "Microsoft" "Windows"}
{"Apple" "Mac" "Microsoft" "Windows"}
You can create a map by grouping values with {}. Although you can use most of Clojure data type as keys, the two most common type of keys are keyword and string.
Get
user=> (get {:Apple "Mac" :Microsoft "Windows"} :Apple)
"Mac"
To get value from key, use get.
user=> (get {:Apple "Mac" :Microsoft "Windows"} :Linux)
nil
You get nil when key doesn't exist.
user=> (get {:Apple "Mac" :Microsoft "Windows"} :Linux "Sorry, no Linux")
nil
You can specify a default value in the third argument which will be returned when the key doesn't exist in the map.
user> (:Apple {:Apple "Mac" :Microsoft "Windows"})
"Mac"
When the key of a map is keyword, you can use the keyword just like a function to get the value.
Assoc
user=> (assoc {:Apple "Mac" :Microsoft "Windows"} :Commodore "Amiga")
{:Commodore "Amiga" :Apple "Mac" :Microsoft "Windows"}
To add a key-value pair, use assoc.
user=> (assoc {:Apple "Mac" :Microsoft "Windows"} :Apple "iOS")
{:Apple "iOS" :Microsoft "Windows"}
If the key already exists, it replaces the value.
Merge
user=> (merge {:Apple "Mac" :Microsoft "Windows"} {1 2})
{1 2, :Apple "Mac" :Microsoft "Windows"}
To combine two maps, use merge.
Keys
user> (keys {:Apple "Mac" :Microsoft "Windows"})
(:Apple :Microsoft)
To get all keys from a map, use keys.
Vals
user> (vals {:Apple "Mac" :Microsoft "Windows"})
("Mac" "Windows")
To get all values from a map, use vals.
Sequences
Sequences are data types that store multiple values. You may wonder: What are differences from lists or vectors? Why Clojure has so many different collection data types?!
Yes, you can use lists and vectors to store multiple values. In fact, lists and vectors are sequences, and other collection data types such as maps or sets are also sequences.
Sequences are data types that abstract all more concrete data types with unified functions. These functions are called the Seq library in Clojure.
One virtue of the sequence is that you can call the same function to collections without worrying about what types of collections that you are dealing with.
Let's take a look at examples of using map to different types of collections.
user=> (map inc [ 1 2 3 ])
(2 3 4)
user=> (map inc `( 1 2 3 ))
(2 3 4)
user=> (map inc #{ 1 2 3 })
(2 4 3)
user=> (map key {:a 1 :b 2 :c 3})
(:a :b :c)
Applying map for the vector.
Applying map for the list.
Applying map for the set.
Applying map for the map. We are using key function in this case because inc doesn't work with the map.
When you can apply functions of the seq library to a data type, we say the data type is seqable. The examples above work because lists, vectors, sets, and maps are all seqable collections.
We will see more functions in the seq library in the following sections to get familiar with sequences.
Seq
To construct a sequence, use seq.
seq takes one seqable collection and converts to a sequence.
The collection data types such as lists, vectors, sets, and maps are all seqable, therefore you can pass any of them to seq.
user=> (seq '(1 2 3))
(1 2 3)
Converting a list to a sequence.
user=> (seq [1 2 3])
(1 2 3)
Converting a vector to a sequence.
user=> (seq #{1 2 3})
(1 3 2)
Converting a set to a sequence.
user=> (seq {:a 1 :b 2 :c 3})
([:a 1] [:b 2] [:c 3])
Converting a map to a sequence.
Seqable data types and seq are what make sequences elegant in Clojure. As long as your data types are seqable, seq will convert the data to a sequence.
This is why you can apply the same functions in the seq library to different collection types transparently. These seq library functions internally convert passed collection to a sequence and do the right things for you.
You may wonder that returned values look like lists in REPL. However, this is just a matter of displaying and they are actually sequences.
user=> (type (seq [1 2 3]))
clojure.lang.PersistentVector$ChunkedSeq
It's clear that it's a sequence if you use type.
First
To get the first element from a sequence, use first.
You probably have used first with different collection data types before without knowing first is actually a sequence function.
user=> (first [1 2 3])
1
Getting the first element in the vector.
user=> (first "string")
\s
Getting the first element in the vector.
You can call first with any collection data types (string is a collection of characters) and get expected behavior because first is a sequence function and all of these data types are seqable.
Rest
user=> (rest [1 2 3])
(2 3)
To get all elements except the first one from a sequence, use rest.
Here we can see another important trait of sequences: sequence function always returns a sequence no matter of what types of collection it takes.
user=> (type [1 2 3])
clojure.lang.PersistentVector
user=> (type (rest [1 2 3]))
clojure.lang.PersistentVector$ChunkedSeq
type tells you the type of data. As you can see, the vector becomes sequence (CheckedSeq is a type of sequence) once it goes through rest function.
Cons
user=> (cons 0 '(1 2))
(0 1 2)
To add an element to the head of sequence, use cons.
user=> (def old-seq '(1 2))
#'user/old-seq
user=> (def new-seq (cons 0 old-seq))
#'user/new-seq
user=> old-seq
(1 2)
user=> new-seq
(0 1 2)
The operation is equivalent to construct a new sequence by adding an element to the existing sequence, therefore cons(cons[truct]).
Concat
user=> (concat '(1 2 3) '(4 5 6))
(1 2 3 4 5 6)
To combine sequences, use concat.
user=> (concat '(1 2) '(4 5) '(7 8) '(9 10))
(1 2 4 5 7 8 9 10)
You can also pass more than two sequences to concat.
Map
user=> (map inc [ 1 2 3 ])
(2 3 4)
To apply a function to each element of a sequence, use map.
user=> (map (fn [x] (inc (val x))) {:a 1 :b 2 :c 3})
(2 3 4)
If you want to do something more complex with each element, you can pass an anonymous function where each value is bound to x.
Reduce
user=> (reduce + [1 2 3 4])
10
reduce boils down elements in a sequence into a single value by applying a function.
The way reduce works is that it first takes out the first two elements from the sequence and apply the function to get a result. Then applying the same function to the result with the third element and keeps doing the same until the end of the sequence. Because of this nature, the function must take two arguments.
user=> (reduce inc [1 2 3 4])
ArityException Wrong number of args (2) passed to: core/inc clojure.lang.AFn.throwArity (AFn.java:429)
Otherwise, you will get an exception (inc is an one argument function)
user=> (reduce (fn [res val] (+ res val)) [1 2 3 4])
10
Of course, you can pass an anonymous function to do more complex stuff. Just don't don't forget that the anonymous function must take two arguments.
user=> (reduce + -10 [1 2 3 4])
0
If you don't want to start with the first element of the sequence, you can pass a starting point in the second argument.
Into
To insert all elements of a sequence into another sequence, use into.
user=> (into [1 2 3] `(4 5 6))
[1 2 3 4 5 6]
Inserting all elements of the list into the vector.
Because of the nature, into is frequently used to convert from one collection type to another.
user=> (into [] `(1 2 3))
[1 2 3]
Converting a list to a vector.
user=> (into (list) [1 2 3])
(3 2 1)
Converting a vector to a list.
user=> (into #{} [1 2 3])
#{1 3 2}
Converting a vector to a set.
user=> (into [] #{1 2 3})
[1 3 2]
Converting a set to a vector.
user=> (into {} [[:a 1] [:b 2] [:c 3]])
{:a 1, :b 2, :c 3}
Converting a nested vector into a map.
user=> (into [] {:a 1 :b 2 :c 3})
[[:c 3] [:b 2] [:a 1]]
Converting a map to a nested vector.
Reverse
user=> (reverse [1 2 3])
(3 2 1)
To reverse a sequence, use reverse.
Iterate
user=> (iterate + 0)
You can get a sequence of infinite integers with iterate. Be careful, though. Running this example will freeze your terminal since the evaluation of this expression never returns.
Range
user=> (range 5 10)
(5 6 7 8 9)
To generates a sequence of numbers between two points, use range.
user=> (range 0 100 5)
(0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80 85 90 95)
You can get integers by every x within the range. In this case, we get a sequence of integers at every 5.
Repeatedly
user=> (repeatedly 5 (fn [] (println "hi!")) )
hi!
hi!
hi!
hi!
hi!
(nil nil nil nil nil)
To repeat something over and over again, use repeatedly. We are passing an anonymous function (fn [] (println "hi!")) because the second argument must be a function.
Doseq
user=> (doseq [animal ["cat" "dog" "horse"]] (println animal) )
cat
dog
horse
nil
Clojure doesn't have for or for-each. Do something to each element of a sequence, use doseq.
user=> (doseq [n1 [1 2 ]
n2 [4 5 ]]
(println (+ n1 n2)))
5
6
6
7
nil
You can bind multiple values. In this case, each element in the first vector is added to each element of the second vector.
Take
user=> (take 5 (range 0 100))
(0 1 2 3 4)
To get the first n elements from a sequence, use take.
user=> (take 10 (range 0 5))
(0 1 2 3 4)
Take all elements from a sequence if the size of the sequence is smaller than n.
Take-While
user=> (take-while neg? [-3 -2 -1 0 1 2 3])
(-3 -2 -1)
To get the first n elements from a sequence as long as the condition is satisfied but stop taking when the condition is not met, use take-while. neg? returns true for negative number.
Note: Taking elements that only satisfies the condition is not what take-while does. That's the job of select.
Drop
user=> (drop 5 (range 0 10))
(5 6 7 8 9)
drop is probably the most primitive way to remove elements from a sequence. drop will remove the first n elements.
Drop-While
user=> (drop-while neg? [-3 -2 -1 0 1 2 3])
(0 1 2 3)
To get the first n elements from a sequence as long as the condition is satisfied but stop dropping when the condition is not met, use drop-while.
Filter
You can remove elements that match the rule you specify from a sequence with filter.
user=> (filter pos? [-1 2 3])
(2 3)
Here is an example to remove positive numbers from a sequence. In this case, being a positive number is the rule that you specify.
The rule is called predicate. Predicates are functions that return boolean values such as pos?.
user=> (filter (fn [v] (= v 2)) [-1 2 3])
(2)
You can construct your own predicate with anonymous functions. In this example, we are removing elements that are 2.
Remove
You can remove elements that matches a predicate with remove. The difference from filter is that returned value is what's removed.
user=> (remove pos? [-1 -2 3 4])
(-1 -2)
In this example, we remove positive numbers from a sequence. The returned values are negative numbers.
Partition-by
user=> (partition-by #(< 3 %) [1 2 3 4 5 6])
((1 2 3) (4 5 6))
To split a collection and group together in a certain way, or in other word partition, use partition. In this example, we partition the vector into two groups: one smaller than or equal 3 and another bigger than 3.
user=> (partition-by #(< 3 %) [1 2 3 4 5 6 1 2 3])
((1 2 3) (4 5 6) (1 2 3))
Notice that (1 2 3) at the end of the sequence is grouped together as a separate sequence from the first one. partition-by doesn't merge values.
Group-by
user=> (group-by #(< 3 %) [1 2 3 4 5 6 1 2 3])
{false [1 2 3 1 2 3], true [4 5 6]}
group-by splits a collection and does merge them together unlike partition-by. group-by returns a map where key is the result of the grouping condition.
Lazy Sequence
Most of Clojure's sequences are lazy. All familiar functions such as map range reduce etc returns lazy sequences.
;; You need hit Ctrl+c very quickly to stop!!
user=> (println (iterate inc 0))
(0 1 2 3 ......
(iterate inc 0) generates a sequence of infinite numbers which, of course, takes infinitely. But, you see println starts printing the numbers (0 1 2 3 ....... If the generation of the sequence never ends, how println can even start printing these numbers?
This is possible because iterate generates lazy sequence and println is able to handle lazy sequence correctly. println asks a number to print from iterate one by one, rather than asking the entire sequence. iterate only computes numbers as it is requested and pass the numbers to println.
user=> (println (take 5 (iterate inc 0)))
(0 1 2 3 4)
nil
take only asks the first n values from lazy sequence. iterate also only computes the first five numbers because that's what asked by take.
For
If you are looking for how to write a loop in Clojure, I'm sorry, but this is not what you are looking for. Clojure doesn't have an imperative loop because there is no mutable local variable in Clojure. Please see the loop section for more information.
In Clojure, for is list comprehension. What is list comprehension? First of all, let's look at an example.
user=> (for [x '(1 2 3)]
(+ 10 x))
(11 12 13)
for takes a vector of one or more collections and iterate over collections while binding each value to symbols.
In short, list comprehension is a way to create a list from existing lists. The idea of list comprehension comes from the world of math. It's used in order to write sets in simpler and easier way.
For example, {x | x >0} means the set of all x that is bigger than than 0. So if x is the set of -1, 1, and 2, then the notation refers to the set of 1 and 2 but not -1.
user=> (for [x '(-1 1 2) :when (< 0 x)]
x)
(1 2)
This is a list comprehension that means the same thing as {x | x >0} in math.
:when modifier evaluates the body only for values where the predicate is true.
user=> (for [x [0 1 2 3 4 5]
:let [y (* x 3)]
:when (even? y)]
y)
(0 6 12)
let modifier can be used to bind intermediate values.
user=> (for [x (range 10) :while (not= x 5)]
x)
(0 1 2 3 4)
while modifier stops the evaluation of the body when the predicate is false.
user=> (for [x ['a 'b 'c]
y [1 2 3]]
[x y])
([a 1] [a 2] [a 3] [b 1] [b 2] [b 3] [c 1] [c 2] [c 3])
for iterates collections in a nested fashion. It's useful to create a combination of all elements in given collections.
Recursion
Function is recursive when the function calls itself inside it's definition. This is the most simple way of doing recursion.
We will start from the example of fibo-recursive function that computes Nth Fibonacci number in the Fibonacci sequence because writing function that computes the Fibonacci numbers is a recursive programming version of hello world.
The Fibonacci sequence is consisted of numbers characterized by the fact that every number after the first two is the sum of the two preceding ones. 0 1 1 2 3 5 8 13 .... are the beginning of the sequence.
user=> (defn fibo-recursive [n]
(if (or (= n 0) (= n 1))
n
(+ (fibo-recursive (- n 1)) (fibo-recursive (- n 2)))))
user=> (fibo-recursive 0)
0
user=> (fibo-recursive 6)
8
As you can see, we are calling fibo-recursive function inside the function body of fibo-recursive function. Calling the function inside the function body is the most basic way to do recursive programming in Clojure and many other programming languages.
Recur
The simple recursion, calling itself inside it's definition, is not the only way to make recursive function in Clojure. recur is a handy tool to do recursion.
user> (defn fibo-recur [iteration]
(let [fibo (fn [one two n]
(if (= iteration n)
one
(recur two (+ one two) (inc n))))]
;; 0N 1N are bigint literals. See Bigint section
;; We need to use bigint to avoid StackOverflow to do the addition of big Fibonacci numbers
;; demonstrated below.
(fibo 0N 1N 0)))
#'user/fibo-recur
user> (fibo-recur 6)
8
We can write a Fibonacci function by using recur as well. recur re-binds it's arguments to new values and call the function with the new values.
user> (defn count-down [result n]
(if (= n 0)
result
(recur (conj result n) (dec n))))
#'user/count-down
user> (count-down [] 5)
[5 4 3 2 1]
Here is another example of the use of recur. It will keep calling count-down function with updated arguments until n becomes 0.
Why do we have recur when you can write a recursive function with the simple recursion like we do in fibo-recursive? One of the most important reasons is the performance optimization.
user> (fibo-recursive 100000)
StackOverflowError clojure.lang.Numbers.equal (Numbers.java:216)
You cannot compute large Fibonacci number with fibo-recursive. When you try to do that, you will get StackOverflowError.
This is because, with simple recursion, each recursive call creates a stack frame which is a data to store the information of the called function on memory. Doing deep recursion requires large memory for stack frames, but since it cannot, we get StackOverflowError.
Although we don't go deeply into details, one of techniques to avoid this problem is making your function tail recursive. A function is tail recursive when the recursion is happening at the end of it's definition. In other words, a tail recursive function must return itself as it's returned value. When you use recur, it makes sure you are doing tail recursion.
user> (defn fibo-loop-recur [current next iteration]
(if (= 0 iteration)
current
(+ 0
(recur next (+ current next) (dec iteration)))))
CompilerException java.lang.UnsupportedOperationException: Can only recur from tail position, compiling:(*cider-repl localhost*:253:10)
In fact, you will get an error when you try to call recur not at the end of a function.
user> (fibo-recur 100000)
;; takes very long time to compute
Because recur does tail recursion, you don't get StackOverflowError with big Fibonacci number although it takes very long time to compute.
Loop
Does Clojure have for/while loop? No, Clojure doesn't provide a way to write an imperative loop because there is no mutable local variable in Clojure. However, you can use loop to write code that works like an imperative loop.
user> (defn count-up [max]
(loop [count 0]
(if (= count max)
(println "Done!")
(do
(println (str "Counting " count))
(recur (inc count))))))
user> (count-up 5)
Counting 0
Counting 1
Counting 2
Counting 3
Counting 4
Done!
nil
Hopefully, this code looks similar to a simple counting loop in non-functional programming languages you've had experienced with before. In this example, recur increments count at the end of each loop and loop uses it in the next loop.
loop is always used with recur and provides a recursion point for recur. A recursion point is a function entry point that recur can go back to do recursion. However, recur doesn't necessary need loop to do it's job as long as a recursion point is provided.
user> (defn count-up-no-loop [count max]
(if (= count max)
(println "Done!")
(do
(println (str "Counting " count))
(recur (inc count) max))))
user> (count-up-no-loop 0 5)
Counting 0
Counting 1
Counting 2
Counting 3
Counting 4
Done!
nil
You can rewrite count-up function without loop. In count-up-no-loop, the recursion point for recur is the function itself. Note that recur takes two arguments now. This is because the number of arguments of recur must match that of it's recursion point function.
One final note: loop/recur is merely a friendly way to write recursion code. All imperative loops can be converted to recursions and all recursions can be converted to loops, so Clojure chose recursions. Although you can write code that looks like an imperative loop with loop/recur, Clojure is doing recursion under the hood.
Macros
Clojure's Macros gives you the power to restructure your Clojure code as you like. For example, you can create your own code syntax, invent new control flow, new types of values, etc.
Defmacro
user=> (defmacro unless [test then]
"Evaluates then when test evaluates to be falsey"
(list 'if (list 'not test)
then))
user=> (unless false (println "false!!"))
false!!
nil
;; Error
user=> (defmacro unless [test then]
"Evaluates then when test evaluates to be falsey"
(list if (list not test)
then))
CompilerException java.lang.RuntimeException: Unable to resolve symbol: if in this context, compiling:(NO_SOURCE_PATH:3:12)
To define a macro, use defmacro. Like function, you can give it a name, docs, and arguments. Note that you are using quotes ' followed by if and not.
This is because you don't want them to be evaluated when you define the macro.
Without quotes, you will see an exception.
Macroexpand
user=> (macroexpand '(unless false (println "hi")))
(if (not false) (println "hi"))
Macros are replaced with Clojure code before it's evaluated. To see how it will be replaced without actually evaluating the macro, use macroexpand.
Note that you have to use ' because you want it to be unevaluated list.
Quotes
user=> (+ 1 2)
3
user=> (quote (+ 1 2))
(+ 1 2)
user=> '(+ 1 2)
(+ 1 2)
Without a quote, this expression will be just evaluated and returns the value.
However, when an expression is surrounded by quote, it does not evaluate the expression but returns the expression itself.
' is another form of quote. It does the exactly same thing with quote. ' is used more often than quote since it's concise.
user=> (defmacro unless [test then]
"Evaluates then when test evaluates to be falsey"
(list 'if (list 'not test)
then))
You can see quoting at work in macros. In this unless macro, you need to use ' followed by if and not because you don't want them to be evaluated inside the macro definition.
user> (require 'clojure.string)
nil
Another common place where quote is used is when loading a namespace.
user> (require clojure.string)
CompilerException java.lang.ClassNotFoundException: clojure.string, compiling:(*cider-repl localhost*:483:7)
You need to quote clojure.string namespace otherwise Clojure tries to resolve the namespace symbol and get error. This is because resolving symbol is the default treatment but clojure.string symbol is not bound to a value.
Syntax-Quotes
user=> `(+ 1 2)
(clojure.core/+ 1 2)
Syntax quoting `works very similarly to quoting ': it returns an unevaluated expression.
user=> '(dec (inc 1))
(dec (inc 1))
user=> `(dec (inc 1))
(clojure.core/dec (clojure.core/inc 1))
However, you see the difference from quoting when the expression contains symbols. Unlike quoting, syntax-quoting returns the fully qualified namespace. Using fully qualified namespace is very important in order to avoid name conflicts when defining macro.
Unquotes
user=> '(+ 1 ~(inc 1))
(+ 1 (clojure.core/unquote (inc 1)))
user=> `(+ 1 ~(inc 1))
(clojure.core/+ 1 2)
You will see another difference between syntax quoting and quoting when syntax quoting is used with unquoting ~. Syntax quoting allows unquoting to evaluate the expression followed by ~.
user=> '(+ 1 ~(inc 1))
(+ 1 (clojure.core/unquote (inc 1)))
Quoting doesn't allow unquoting to evaluate an expression.
Unquote-Splice
user=> `(+ ~(list 1 2 3))
(clojure.core/+ (1 2 3))
user=> `(+ ~@(list 1 2 3))
(clojure.core/+ 1 2 3)
The ~@ unquote splice works just like ~ unquote, except it expands a sequence and splice the contents of the sequence into the enclosing syntax-quoted data structure.
Threading Macros
Threading Macros are macros that helps you to write nested forms in a cleaner and more readable way. Despite it's name, threading macros are nothing to do with threads in the parallel computing.
->
-> is called thread-first macro. It's first because it's passing down the evaluation of former forms to the first argument of preceding forms.
user> (conj (conj (conj [] 1) 2) 3)
[1 2 3]
Suppose if you want to start from an empty vector and adding numbers to the vector one by one. Here is nested version of the code.
As you add more numbers, the nesting gets deeper and makes your code harder to read. The thread-first macro solves this nesting problem.
user> (-> []
(conj 1)
(conj 2)
(conj 3))
[1 2 3]
Here is the same code with thread-first macro.
The first argument is the initial value that you want to start from. After the first argument is evaluated, it is then passed to the first argument of (conj 1). This is equivalent to (conj [] 1). The evaluated value is then passed to to the first argument of (conj 2). This is equivalent to (conj [1] 2). Finally, we are evaluating (conj [1 2] 3) which returns [1 2 3].
->>
->> is called thread-last macro. It's last because it's passing down the evaluation of former forms to the last argument of preceding forms.
map is an example of such function that takes a collection in the last argument and apply the function in the first argument.
user> (->> ["Japan" "China" "Korea"]
(map clojure.string/upper-case)
(map #(str "Hello " %)))
("Hello JAPAN!" "Hello CHINA!" "Hello KOREA!")
This code converts country names to upper case and say hello to the countries. The vector of country names are passed to the last argument of the first map which is equivalent to (map clojure.string/upper-case ["japan" "china" "korea"]). Then it's passed to the second map which is equivalent to (map #(str "Hello " %) ["JAPAN" "CHINA" "KOREA"]).
Remember that #() is another way to write a anonymous function.
Delays
Delay
When you want to defer the evaluation of an expression, use delay.
user> (def later (do [] (prn "Adding") (+ 1 2)))
"Adding"
#'user/later
user> (def later (delay (do [] (prn "Adding") (+ 1 2))))
#'user/later
This is the example of immediately evaluating an expression. Nothing special is involved here. (do ...) is executed immediately and it's return value is bound to later var.
When you use delay, the expression is not evaluated immediately, so "Adding" is not printed.
Force
user> (def later (delay (do [] (prn "Adding") (+ 1 2))))
#'user/later
user> (force later)
"Adding"
3
To evaluate and obtain the result of a delayed expression, use force.
user> (def later (fn [] (prn "Adding") (+ 1 2) ))
user> (later)
"Adding"
3
You can achieve the same thing by using an anonymous function and def. Then, why do we get bothered with delay?
user> (def later (delay (do [] (prn "Adding") (+ 1 2))))
#'user/later
user> (force later)
"Adding"
3
user> (force later)
3
The difference from a plain function is that delay is only evaluated once and caches the result. "Adding" is only printed once because delay returns cached result from the second time.
Futures
Future
user=> (do
(Thread/sleep 3000)
(println "hello"))
;; Wait for 3 sec and then "hello" is printed
hello
nil
"hello" is printed after sleeping 3 seconds. This is very obvious because these lines of the code are executed synchronously.
user=> (do
(future
(Thread/sleep 3000)
(println "after sleep"))
(println "hello"))
hello
nil
after sleep
If you use future, (println "hello") is evaluated immediately, and after three seconds, (println "after sleep") will be evaluated.
This is because Clojure puts the expression grouped by future into another thread and moves the current thread forward.
Calls inside future still blocks. So, in this case, "after sleep" is printed after 3 secs.
Deref
user> (let [future-val (future (inc 1))]
(println future-val))
#<core$future_call$reify__6320@142cbba: 2>
nil
user> (let [future-val (future (inc 1))]
(println (deref future-val)))
2
nil
future can return values.
See the returned value #<core$future_call$reify__6320@142cbba: 2> which is not what you want. This returned value is the current state of the future, not the returned value of (inc 1)
To obtain the returned value of (inc 1), you need to dereference the future with deref.
user> (let [future-val (future (inc 1))]
(println @future-val))
2
nil
You can also use @ to dereference a future.
user> @(future (Thread/sleep 3000) "returned!")
;; Waiting three seconds...
"returned!"
When you dereference a future, you will block until the result is returned.
user> (deref (future (Thread/sleep 1000) "I made it!") 2000 "Can't wait anymore!")
"I made it!"
user> (deref (future (Thread/sleep 3000) "I made it!") 2000 "Can't wait anymore!")
"Can't wait anymore!"
You can tell deref how long you want to wait along with a value to return if it does time out.
user> (let [sleep-and-wait
(map (fn [time]
(future
(Thread/sleep time)
(println (str "slept " time " sec" ))))
[1000 2000])]
(doall (map deref sleep-and-wait))
(println "done"))
slept 1000 sec
slept 2000 sec
done
Finally, you can do a useful thing by combining future and deref. You can run multiple time consuming tasks in different threads and block until they finish.
Realized?
user> (def my-future (future (Thread/sleep 5000) ))
user> (repeatedly 6
(fn []
(println (realized? my-future))
(Thread/sleep 1000)))
#'user/my-futurefalse
false
false
false
false
true
To know if a future is already done, use realized?.
realized returns true after 5 seconds.
Promises
Promise
When you want to defer the evaluation of expressions until you obtain values to pass to them, use promise. The easiest example why you want to use promise is implementing a callback.
user> (def my-promise (promise))
#'user/my-promise
user> (def listen-and-callback (fn []
(println "Start listening...")
(future (println "Callback fired: " @my-promise))))
#'user/listen-and-callback
user> (defn do-time-consuming-job []
(Thread/sleep 5000)
(deliver my-promise "delivered value"))
#'user/do-time-consuming-job
user> (listen-and-callback) (do-time-consuming-job)
Start listening...
Callback fired: delivered value
First, you make a promise with promise.
Creating a listener that listens to the promise and fire the callback when a value is delivered to the promise. Just like future, promise will block when you dereference it.
Defining a job that takes 5 seconds to finish.
Now let's start the listener and wait for the time consuming job. After being blocked by the dereference of @my-promise for 5 seconds, you will see the callback is fired.
Atoms
Atom
You've might hear this statement before: there is no state in Clojure. Thus, the language is impractical and cannot be used to build real applications. However, this is not true. Clojure has built-in mechanisms to manage application state. Atom is one of the mechanisms.
user> (def atom-str (atom "hello"))
#'user/atom-str
user> (def atom-vector (atom [1 2 3]))
#'user/atom-vector
user> (def atom-map (atom {:a "aaa" :b "bbb"}))
#'user/atom-map
user> (def atom-int (atom 53))
#'user/atom-int
Use atom to create an atom that points to a value. You can create an atom of any values.
user> (deref atom-int)
53
user> @atom-int
53
To obtain the value of an atom, use deref or @.
Reset!
user> (def atom-int (atom 53))
#'user/atom-int
user> (reset! atom-int 35)
35
user> @atom-int
35
You can set the value of an atom with reset!. It is used when you are setting the value without regard for the
current value, normally the first time you create the atom.
user> (reset! atom-int 100)
100
user> @atom-int
100
user> (reset! atom-int 200)
200
user> @atom-int
200
Atoms are mutable, so you can update as many times as you want.
Swap!
swap! allows you to use a function to update the value of an atom.
user> (def atom-int (atom 0))
#'user/atom-int
user> (swap! atom-int
(fn [current-atom]
(inc current-atom)))
1
user> (swap! atom-int
(fn [_]
"not int"))
"not int"
user> @atom-int
"not int"
The function that you pass to swap! will take an argument which is the current atom.
The atom is updated by the return value of the function.
user> (def atom-int (atom 100))
#'user/atom-int
user> (defn multiple-by
[current-atom num]
(* current-atom num))
user> (swap! atom-int multiple-by 10)
1000
You can pass a function that takes multiple arguments. The first argument of the function is the current atom.
Thread Safety
Atoms are very similar to mutable variables in other programming languages. You can assign value to an atom and update anytime you want. However, Clojure's atom has one big advantage over them: it's thread safe.
user> (def x 0)
#'user/x
user> (repeatedly 10
(fn [] (def x (inc x))))
(#'user/x...
user> x
10
This will update x ten times and increment x by 1 every time. The final value of x will be 10.
user> (def x 0)
#'user/x
user> (repeatedly 10
(fn [] (future (def x (inc x)))))
(#<core$future_call$reify__6320@410e4786: :pending> #<core$futur...
user> x
5
Similarly, this will update x ten times and increment x every time like the previous example. However, with this code, (def x (inc x)) will be executed in parallel on different threads because we are using future. When you do this, the final value of x will not be deterministic anymore. Sometimes it is 5, and sometimes 9 because each thread access and update the same x in its own timing.
user> (def x (atom 0))
#'user/x
user> (repeatedly 10
(fn [] (future (swap! x inc))))
(#<core$future_call$reify__6320@632796c6: :pending>...
user> @x
10
Now atom comes to rescue. x is atom and we use swap! to update the value. Unlike vars, atom is thread safe, so x will be updated by one thread at one time. Thus, the final value of x is guaranteed to be 10. This is achieved thanks to the Clojure's use of compare-and-swap in atom.
Refs
Ref
While Atom is handy to manage a state in a consistent way, Ref allows you to manage multiple states while ensuring they are consistent.
user> (def my-ref (ref 0))
#'user/my-ref
To create a ref, use ref.
user> (deref my-ref)
0
user> @my-ref
0
To obtain the value of a ref, use deref or @.
Do-sync
user> (deref my-ref)
0
user> @my-ref
0
user> (dosync
(ref-set my-ref 1)
(ref-set my-ref 2))
2
user> @my-ref
2
The update of refs must be done inside dosync block. dosync is telling Clojure where the transaction update starts from. To set a ref to a new value, use ref-set.
user> (ref-set my-ref 3)
IllegalStateException No transaction running clojure.lang.LockingTransaction.getEx (LockingTransaction.java:208)
Any updates to refs always has to be done inside dosync in order to make transactional updates. Otherwise, Clojure complains with No transaction running exception.
Alter
alter allows you to use a function to update the value of a ref.
user> (def my-ref (ref 0))
#'user/my-ref
user> (dosync
(alter my-ref
(fn [current_ref]
(inc current_ref))))
1
user> @my-ref
1
user> (dosync
(alter my-ref
(fn [_] "not int")))
"not int"
user> @my-ref
"not int"
The function that you pass to alter will take an argument which is the current ref.
The ref is updated by the return value of the function.
user> (def my-ref (ref 100))
#'user/atom-int
user> (defn multiple-by
[current-ref num]
(* current-ref num))
user> (dosync
(alter my-ref multiple-by 10))
1000
You can pass a function that takes multiple arguments. The first argument of the function is the current atom.
Transaction
This piece of code demonstrates how transaction works.
user> (def user (ref {}))
#'user/user
user> (dosync
(alter user merge {:name "Kim"})
(throw (Exception. "something wrong happens!"))
(alter user merge {:age 32}))
Exception something wrong happens! user/eval2997/fn--2998 (NO_SOURCE_FILE:2)
user> @user
{}
Suppose we are trying to create an user record in database. Each alter tries to update user-record ref with user info and you want the ref to be updated only when both alter succeed.
But, let's assume something wrong occurs between the first and the second alter.
As you see, the user-record ref is still empty. This is because alter inside dosync doesn't update the ref until getting out of dosync block successfully.
user> (def user-record (atom {}))
#'user/user-record
user> (do
(swap! user-record merge {:name "Kim"})
(throw (Exception. "something wrong happens!"))
(swap! user-record merge {:age 32}))
Exception something wrong happens! user/eval3024 (NO_SOURCE_FILE:3)
user> @user-record
{:name "Kim"}
This is the atom version that doesn't work. As you see, user-record atom is half updated when there is the exception.
user> (def my-ref (ref 0))
#'user/my-ref
user> (future
(dosync
(alter my-ref inc)
(Thread/sleep 5000)))
#<core$future_call$reify__6320@6ef7be6a: :pending>
user> (println @my-ref)
0
;; Wait 5 seconds
user> (println @my-ref)
1
The other way to see how transaction works is trying to observe the value of ref outside dosync block.
We use future to run the whole transaction in the separate thread and wait two seconds before exiting the dosync block.
The value of the ref is still 0 at this moment because the update to the ref is still not committed.
Java
One of the great traits of Clojure is that you can use Java code from your Clojure code. This trait is called Java interop. Although Clojure has very rich standard libraries, sometimes you cannot find libraries that you need to solve your problems. If the library exists in Java, you can borrow it from your Clojure code.
Instantiation
user> (new java.util.Date)
#inst "2017-01-15T08:04:14.983-00:00"
You can create an instance with new which takes class name as first argument.
user> (new java.util.Date "2016/2/19")
#inst "2016-02-18T15:00:00.000-00:00"
The rest of arguments are passed to the constructor function.
user> (java.util.Date.)
#inst "2017-01-15T08:17:02.580-00:00"
user> (java.util.Date. "2016/2/19")
#inst "2016-02-18T15:00:00.000-00:00"
There is also . form available. . must be placed at the end of class name.
user> (let [current_date (new java.util.Date)]
(println current_date))
#inst "2017-01-15T13:02:29.613-00:00"
nil
You can also bind Java's instance just like Clojure's value.
Method invocation
Clojure doesn't provide an exponential calculation function in the standard library, so let's borrow pow method from Math class.
user> (Math/pow 2 3)
8.0
You can call Java's method just like Clojure's function. Here is how to call pow class method of Math class. The class method invocation takes a form of (Classname/Method).
user> (let [current_date (new java.util.Date)]
(.toString current_date))
"Sun Jan 15 21:44:06 JST 2017"
The instance method invocation takes a form of (.MethodName Instance Args). This example is equivalent to current_date.toString() in Java.
user> (let [current_date (new java.util.Date)]
(. current_date toString))
"Sun Jan 15 22:30:45 JST 2017"
There is also . form available.
user> (let [date1 (new java.util.Date)
date2 (new java.util.Date)]
(.equals date1 date2))
true
If you want to call a method that takes arguments, you can pass them after an instance. This example is equivalent to date1.equals(date2) in Java.
Many Thanks
CLOJURE for the BRAVE and TRUE
And many other great articles and pages made by the Clojure community.