##// END OF EJS Templates
Fix typo
Douglas Blank -
Show More
@@ -1,121 +1,121 b''
1 # encoding: utf-8
1 # encoding: utf-8
2 """
2 """
3 Utilities for timing code execution.
3 Utilities for timing code execution.
4 """
4 """
5
5
6 #-----------------------------------------------------------------------------
6 #-----------------------------------------------------------------------------
7 # Copyright (C) 2008-2011 The IPython Development Team
7 # Copyright (C) 2008-2011 The IPython Development Team
8 #
8 #
9 # Distributed under the terms of the BSD License. The full license is in
9 # Distributed under the terms of the BSD License. The full license is in
10 # the file COPYING, distributed as part of this software.
10 # the file COPYING, distributed as part of this software.
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12
12
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14 # Imports
14 # Imports
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16
16
17 import time
17 import time
18
18
19 #-----------------------------------------------------------------------------
19 #-----------------------------------------------------------------------------
20 # Code
20 # Code
21 #-----------------------------------------------------------------------------
21 #-----------------------------------------------------------------------------
22
22
23 # If possible (Unix), use the resource module instead of time.clock()
23 # If possible (Unix), use the resource module instead of time.clock()
24 try:
24 try:
25 import resource
25 import resource
26 except ImportError:
26 except ImportError:
27 resource = None
27 resource = None
28
28
29 # Some implementations (like jyputerlite) don't have getrusage
29 # Some implementations (like jyputerlite) don't have getrusage
30 if resource not None and hasattr(resource, "getrusage"):
30 if resource is not None and hasattr(resource, "getrusage"):
31 def clocku():
31 def clocku():
32 """clocku() -> floating point number
32 """clocku() -> floating point number
33
33
34 Return the *USER* CPU time in seconds since the start of the process.
34 Return the *USER* CPU time in seconds since the start of the process.
35 This is done via a call to resource.getrusage, so it avoids the
35 This is done via a call to resource.getrusage, so it avoids the
36 wraparound problems in time.clock()."""
36 wraparound problems in time.clock()."""
37
37
38 return resource.getrusage(resource.RUSAGE_SELF)[0]
38 return resource.getrusage(resource.RUSAGE_SELF)[0]
39
39
40 def clocks():
40 def clocks():
41 """clocks() -> floating point number
41 """clocks() -> floating point number
42
42
43 Return the *SYSTEM* CPU time in seconds since the start of the process.
43 Return the *SYSTEM* CPU time in seconds since the start of the process.
44 This is done via a call to resource.getrusage, so it avoids the
44 This is done via a call to resource.getrusage, so it avoids the
45 wraparound problems in time.clock()."""
45 wraparound problems in time.clock()."""
46
46
47 return resource.getrusage(resource.RUSAGE_SELF)[1]
47 return resource.getrusage(resource.RUSAGE_SELF)[1]
48
48
49 def clock():
49 def clock():
50 """clock() -> floating point number
50 """clock() -> floating point number
51
51
52 Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of
52 Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of
53 the process. This is done via a call to resource.getrusage, so it
53 the process. This is done via a call to resource.getrusage, so it
54 avoids the wraparound problems in time.clock()."""
54 avoids the wraparound problems in time.clock()."""
55
55
56 u,s = resource.getrusage(resource.RUSAGE_SELF)[:2]
56 u,s = resource.getrusage(resource.RUSAGE_SELF)[:2]
57 return u+s
57 return u+s
58
58
59 def clock2():
59 def clock2():
60 """clock2() -> (t_user,t_system)
60 """clock2() -> (t_user,t_system)
61
61
62 Similar to clock(), but return a tuple of user/system times."""
62 Similar to clock(), but return a tuple of user/system times."""
63 return resource.getrusage(resource.RUSAGE_SELF)[:2]
63 return resource.getrusage(resource.RUSAGE_SELF)[:2]
64 except ImportError:
64 except ImportError:
65 # There is no distinction of user/system time under windows, so we just use
65 # There is no distinction of user/system time under windows, so we just use
66 # time.perff_counter() for everything...
66 # time.perff_counter() for everything...
67 clocku = clocks = clock = time.perf_counter
67 clocku = clocks = clock = time.perf_counter
68 def clock2():
68 def clock2():
69 """Under windows, system CPU time can't be measured.
69 """Under windows, system CPU time can't be measured.
70
70
71 This just returns perf_counter() and zero."""
71 This just returns perf_counter() and zero."""
72 return time.perf_counter(),0.0
72 return time.perf_counter(),0.0
73
73
74
74
75 def timings_out(reps,func,*args,**kw):
75 def timings_out(reps,func,*args,**kw):
76 """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output)
76 """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output)
77
77
78 Execute a function reps times, return a tuple with the elapsed total
78 Execute a function reps times, return a tuple with the elapsed total
79 CPU time in seconds, the time per call and the function's output.
79 CPU time in seconds, the time per call and the function's output.
80
80
81 Under Unix, the return value is the sum of user+system time consumed by
81 Under Unix, the return value is the sum of user+system time consumed by
82 the process, computed via the resource module. This prevents problems
82 the process, computed via the resource module. This prevents problems
83 related to the wraparound effect which the time.clock() function has.
83 related to the wraparound effect which the time.clock() function has.
84
84
85 Under Windows the return value is in wall clock seconds. See the
85 Under Windows the return value is in wall clock seconds. See the
86 documentation for the time module for more details."""
86 documentation for the time module for more details."""
87
87
88 reps = int(reps)
88 reps = int(reps)
89 assert reps >=1, 'reps must be >= 1'
89 assert reps >=1, 'reps must be >= 1'
90 if reps==1:
90 if reps==1:
91 start = clock()
91 start = clock()
92 out = func(*args,**kw)
92 out = func(*args,**kw)
93 tot_time = clock()-start
93 tot_time = clock()-start
94 else:
94 else:
95 rng = range(reps-1) # the last time is executed separately to store output
95 rng = range(reps-1) # the last time is executed separately to store output
96 start = clock()
96 start = clock()
97 for dummy in rng: func(*args,**kw)
97 for dummy in rng: func(*args,**kw)
98 out = func(*args,**kw) # one last time
98 out = func(*args,**kw) # one last time
99 tot_time = clock()-start
99 tot_time = clock()-start
100 av_time = tot_time / reps
100 av_time = tot_time / reps
101 return tot_time,av_time,out
101 return tot_time,av_time,out
102
102
103
103
104 def timings(reps,func,*args,**kw):
104 def timings(reps,func,*args,**kw):
105 """timings(reps,func,*args,**kw) -> (t_total,t_per_call)
105 """timings(reps,func,*args,**kw) -> (t_total,t_per_call)
106
106
107 Execute a function reps times, return a tuple with the elapsed total CPU
107 Execute a function reps times, return a tuple with the elapsed total CPU
108 time in seconds and the time per call. These are just the first two values
108 time in seconds and the time per call. These are just the first two values
109 in timings_out()."""
109 in timings_out()."""
110
110
111 return timings_out(reps,func,*args,**kw)[0:2]
111 return timings_out(reps,func,*args,**kw)[0:2]
112
112
113
113
114 def timing(func,*args,**kw):
114 def timing(func,*args,**kw):
115 """timing(func,*args,**kw) -> t_total
115 """timing(func,*args,**kw) -> t_total
116
116
117 Execute a function once, return the elapsed total CPU time in
117 Execute a function once, return the elapsed total CPU time in
118 seconds. This is just the first value in timings_out()."""
118 seconds. This is just the first value in timings_out()."""
119
119
120 return timings_out(1,func,*args,**kw)[0]
120 return timings_out(1,func,*args,**kw)[0]
121
121
General Comments 0
You need to be logged in to leave comments. Login now