Clojure Core

Namespaces

clojure
- core
  - protocols
- inspector
- java
  - browse
  - io
  - javadoc
  - shell
- main
- pprint
- repl
- set
- stacktrace
- string
- template
- test
  - junit
  - tap
- walk
- xml
- zip

You're viewing version 1.2.0 of mod. The latest stable version of Clojure Core is 1.3.0.

doc source examples comments

1.2.0

1.2.0
1.3.0

mod

clojure.core

(mod num div)

Modulus of num and div. Truncates toward negative infinity.

1 Example top

link | changes
```
user=> (mod 10 5)
0

user=> (mod 10 6)
4

user=> (mod 10 10)
0

user=> (mod 10 -1)
0

;; The mod function is defined as the amount by which a number exceeds the largest integer multiple of the divisor that is not greater than that number.
;; The largest integer multiple of 5 not greater than -2 is 5 * -1 = -5. The amount by which -2 exceeds -5 is 3. 
;;
user=> (mod -2  5) 
3
```
<pre> user=> (mod 10 5) 0 user=> (mod 10 6) 4 user=> (mod 10 10) 0 user=> (mod 10 -1) 0 ;; The mod function is defined as the amount by which a number exceeds the largest integer multiple of the divisor that is not greater than that number. ;; The largest integer multiple of 5 not greater than -2 is 5 * -1 = -5. The amount by which -2 exceeds -5 is 3. ;; user=> (mod -2 5) 3 </pre>

Source clojure/core.clj:2734 top

(defn mod
  "Modulus of num and div. Truncates toward negative infinity."
  {:added "1.0"}
  [num div] 
  (let [m (rem num div)] 
    (if (or (zero? m) (pos? (* num div))) 
      m 
      (+ m div))))

Vars in clojure.core/mod: * + defn let num or pos? zero?

Used in 1 other vars gcd

Comments top

1 comment(s) for mod.

wdkrnls

link

The difference between rem and mod can be remembered by noting that mod always returns a value between 0 and div.

ClojureDocs(beta)