BenchmarkBuilder (Groovy Documentation)

groovy.groovyx.gbench.BenchmarkBuilder

A builder for micro-benchmarking.

This builder allows accurate and easy benchmark. For example, you can benchmark character concatenation using StringBuilder and StringBuffer and compare their performances like the following:


 def bm = new BenchmarkBuilder().run {
     'StringBuilder' {
         def sb = new StringBuilder()
         sb.append('foo')
         sb.append('bar')
         sb.append('baz')
         sb.toString()
     }
     'StringBuffer' {
         def sb = new StringBuffer()
         sb.append('foo')
         sb.append('bar')
         sb.append('baz')
         sb.toString()
     }
 }
 bm.prettyPrint()


 then means (in nanoseconds) of each execution time will be printed out:
                 user  system  cpu  real

 StringBuilder   283       0  284   286
 StringBuffer    319       0  319   321
 

 

 
Authors:
Nagai Masato




    
        
        
        

        
        
        
        
            
                
                    Field Summary
                    
                    
                        Fields 
                        
                            Modifiers
                            Name
                            Description
                        
                        
                        
                            static int 
                            AUTO
                            
                        
                        
                    
                   
                
                
            
        

        
        
         
                
                    Properties Summary
                    
                    
                        Properties 
                        
                            Type
                            Name and description
                        
                        
                        
                            BenchmarkList 
                            benchmarks

                        
                        
                    
                   
                
            
        

        
        

        

        
        
        
            
            
                    Methods Summary
                    
                    
                        Methods 
                        
                            Type
                            Name and description
                        
                        
                        
                            def
                            invokeMethod(String name, Object args)

                        
                        
                        
                            def
                            run(Map options = [:], Closure clos)
Gets benchmarks.
                        
                        
                        
                            String
                            toString()

                        
                        
                        
                            def
                            with(String label, Closure clos)
Adds a code block as a benchmark target.
                        
                        
                    
                   
              
            
            
                    Inherited Methods Summary
                    
                    
                        Inherited Methods 
                        
                            Methods inherited from class
                            Name
                        
                        
                        
                            class Object
                            wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
                        
                    
                   
              
                
        
        
    
    



    
        
           

            
            
            
                
                    
                
                    Field Detail
                    
                        
                        
                            
                                public static int AUTO
                                
                            
                        
                    
                
            
            

            
            
            
                
                    
                
                    Property Detail
                    
                        
                        
                            
                                BenchmarkList benchmarks
                                
                            
                        
                    
                
            
            

            

            


            
            
            
                
                    
                
                    Method Detail
                    
                        
                        
                            
                                def invokeMethod(String name, Object args)
                                
                            
                        
                    
                        
                        
                            
                                def run(Map options = [:], Closure clos)
                                 Gets benchmarks.
     
Parameters:
options
 -  
 warmUpTime: the length of time (in seconds) to warm up Groovy and JVM.
              the default value is AUTO.
 maxWarmUpTime: the maximum length of time (in seconds) that is used when warmUpTime is AUTO.
 
measureCpuTime: measure CPU time. the default value depends on JVM.
 quiet: suppress output. the default value is false.
 
verbose: enable verbose output. the default value is false.
 
clos -  a closure to add code blocks for benchmarking.
Returns:
a list of benchmarks

                            
                        
                    
                        
                        
                            
                                String toString()
                                
                            
                        
                    
                        
                        
                            
                                def with(String label, Closure clos)
                                 Adds a code block as a benchmark target.
deprecated:
Use the following alternate syntax instead:
               label { code }
     Parameters:
label -  the label of the code block.
clos -  a code block.

                            
                        
                    
                
            
            
        
    





    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    



    
        
            Frames
            No Frames
        
    
    
        
            Summary: 
            Nested   Field
   Property
   Constructor   Method   
        
        
             | Detail: 
            Field
   Property
   Constructor   Method   
        
    
    Groovy Documentation

Type	Name and description
`def`	`invokeMethod(String name, Object args)`
`def`	`run(Map options = [:], Closure clos)` Gets benchmarks.
`String`	`toString()`
`def`	`with(String label, Closure clos)` Adds a code block as a benchmark target.

[Groovy] Class BenchmarkBuilder

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static int AUTO

Property Detail

BenchmarkList benchmarks

Method Detail

def invokeMethod(String name, Object args)

def run(Map options = [:], Closure clos)

String toString()

def with(String label, Closure clos)