Skip to content

Commit 663561c

Browse files
committed
Add an example
1 parent b4ae2ba commit 663561c

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,24 @@ Precision is a simple crate to perform measurements using hardware counters.
44

55
It is especially useful for performing micro-benchmarks.
66

7-
[API documentation](https://docs.rs/precision)
7+
## [API documentation](https://docs.rs/precision)
8+
9+
## Example
10+
11+
```rust
12+
extern crate precision;
13+
14+
let p = precision::Precision::new(precision::Config::default()).unwrap();
15+
16+
let start = p.now();
17+
let stop = p.now();
18+
let elapsed1 = stop - start;
19+
20+
let start = p.now();
21+
let stop = p.now();
22+
let elapsed2 = stop - start;
23+
24+
let elapsed_total = elapsed1 + elapsed2;
25+
let elapsed_total_secs = elapsed_total_as_secs_f64();
26+
let hw_ticks = elapsed_total.ticks();
27+
```

0 commit comments

Comments
 (0)