1 Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
   2 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 
   4 This code is free software; you can redistribute it and/or modify it
   5 under the terms of the GNU General Public License version 2 only, as
   6 published by the Free Software Foundation.  Oracle designates this
   7 particular file as subject to the "Classpath" exception as provided
   8 by Oracle in the LICENSE file that accompanied this code.
   9 
  10 This code is distributed in the hope that it will be useful, but WITHOUT
  11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13 version 2 for more details (a copy is included in the LICENSE file that
  14 accompanied this code).
  15 
  16 You should have received a copy of the GNU General Public License version
  17 2 along with this work; if not, write to the Free Software Foundation,
  18 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19 
  20 Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21 or visit www.oracle.com if you need additional information or have any
  22 questions.
  23 
  24 =======================================================================
  25 
  26 The tests are divided by scenario.
  27 
  28 Each scenario has the problem it tries to solve, and it does that with several options:
  29   - BulkBench only compares handmade solutions vs. JDK bulk operations, without resorting to lambdas/methodrefs
  30   - LambdaBench does bulk operations with lambdas/methodrefs
  31   - XtrasBench has some other interesting options
  32 
  33 All tests in these benchmarks follow the following naming convention.
  34 Test names is the concatenation of several markers:
  35 
  36 {hm|bulk}: infrastructure used
  37   - hm: "handmade" version which users would presumably implement otherwise
  38   - bulk: JDK8-ish bulk operation
  39 
  40 {seq|par}: parallelism mode
  41   - seq: sequential mode
  42   - par: parallel mode; in "hm" case, this might have different implementations
  43 
  44 {.|inner|lambda|mref}: functional interface type
  45   - .: no specific meaning
  46   - inner: explicit inner class
  47   - lambda: JDK8-ish lambda
  48   - mref: JDK8-ish method ref
  49 
  50 E.g. bulk_seq_inner is the test harnesses JDK8 bulk operations in sequential mode, and explicit inner class as function
  51 
  52 All benchmarks should be executed in the following modes (see -t harness cmdline option):
  53  - single mode (thread = 1),
  54  - core mode   (thread = number of cores),
  55  - max mode    (thread = number of HW threads).