Merge branch 'release/v1.1.0'

Author: John Farrier

.travis.yml

@@ -1,47 +1,33 @@
-language: 
-  - cpp
-
+language: cpp
 compiler:
-  - clang
-  - gcc
-
-# Setup different environments to test
-env:
-  global:
-    - GCC_VERSION="4.9"
-  matrix:
-  - CPP14=0
-  - CPP14=1
+    - gcc
+    # - clang # This is not currently working because it seems to still be looking at GCC include directories.
 
-# Setup repos etc before installation
 before_install:
-  - if [ "$CXX" == "g++" ]; then sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test; fi
-  - if [ "$CXX" == "clang++" -a "$CPP14" == "0" ]; then sudo add-apt-repository -y ppa:h-rayflood/llvm; fi
-  - sudo apt-get update -qq
+    - echo "yes" | sudo add-apt-repository ppa:kalakris/cmake
+    - echo "yes" | sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
+    - sudo apt-get update -qq
+    - sudo apt-get install -qq
+    - sudo apt-get install cmake
+    # g++4.8.1
+    - if [ "$CXX" == "g++" ]; then sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test; fi
+ 
+    # clang 3.4
+    - if [ "$CXX" == "clang++" ]; then sudo add-apt-repository -y ppa:h-rayflood/llvm; fi
+ 
+    - sudo apt-get update -qq
 
-# Install dependencies
 install:
-  # install g++ 4.8, if tests are run with g++
-  - if [ "$CXX" = "g++" ]; then sudo apt-get install -qq "g++-${GCC_VERSION}"; fi
-  - if [ "$CXX" = "g++" ]; then export CXX="g++-${GCC_VERSION}" CC="gcc-${GCC_VERSION}"; fi
-
-  # install clang-3.4 if CPP14==1
-  - if [ "$CXX" == "clang++" -a "$CPP14" == "0" ]; then sudo apt-get install --allow-unauthenticated -qq clang-3.3; fi
-
-  - if [ "$CXX" == "clang++" ]; then cwd=$(pwd); fi
-
-  # Install libc++ if tests are run with clang++
-  - if [ "$CXX" == "clang++" -a "$CPP14" == "0" ]; then svn co --quiet http://llvm.org/svn/llvm-project/libcxx/trunk@181765 libcxx; fi
-  - if [ "$CXX" == "clang++" -a "$CPP14" == "1" ]; then svn co --quiet http://llvm.org/svn/llvm-project/libcxx/trunk@201601 libcxx; fi
-
-  - if [ "$CXX" == "clang++" ]; then cd libcxx/lib && bash buildit; fi
-  - if [ "$CXX" == "clang++" ]; then sudo cp ./libc++.so.1.0 /usr/lib/; fi
-  - if [ "$CXX" == "clang++" ]; then sudo mkdir /usr/include/c++/v1; fi
-  - if [ "$CXX" == "clang++" ]; then cd .. && sudo cp -r include/* /usr/include/c++/v1/; fi
-  - if [ "$CXX" == "clang++" ]; then cd /usr/lib && sudo ln -sf libc++.so.1.0 libc++.so; fi
-  - if [ "$CXX" == "clang++" ]; then sudo ln -sf libc++.so.1.0 libc++.so.1 && cd $cwd; fi
-
-  - if [ "$CXX" == "clang++" -a "$CPP14" == "0" ]; then CXX=clang++-3.3; fi
+  # g++4.8.1
+  - if [ "$CXX" = "g++" ]; then sudo apt-get install -qq g++-4.8; fi
+  - if [ "$CXX" = "g++" ]; then export CXX="g++-4.8" CC="gcc-4.8"; fi
+  - if [ "$CXX" = "g++" ]; then sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-4.8 90; fi
+  - if [ "$CXX" = "g++" ]; then sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.8 90; fi
+  - if [ "$CXX" = "g++" ]; then sudo apt-get install libstdc++-4.8-dev; fi
+ 
+  # clang 3.4
+  - if [ "$CXX" == "clang++" ]; then sudo apt-get install --allow-unauthenticated -qq clang-3.4; fi
+  - if [ "$CXX" == "clang++" ]; then export CXX="clang++-3.4"; fi
 
 # command to run tests
 script: 
@@ -51,7 +37,7 @@ script:
   - pwd
   - cd build
   - pwd
-  - cmake .. -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DCMAKE_CXX_FLAGS="-std=${STD}"
+  - cmake ..
   - ls
   - make
 

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# How to contribute
+
+Adding great features and ensuring the widest possible platform compatibility requires community participation.  Anyone wishing to contribute should review these guidelines before submitting pull requests.
+
+## Celero Core vs Example Experiments
+
+New functionality would reside inside the core project for Celero.  Here it is most important that guidelines are followed to include code formatting, ISO C++ compliance, etc.  The requirements on example experiments are less strict to allow individuals to share their projects the way they wrote them, though adherence to coding standards would be greatly appreciated.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub
+
+## Making Changes
+
+Change should generally follow the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model.
+
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target release branches if you are certain your fix must be on that branch.
+  * To quickly create a topic branch based on master; `git checkout -b fix/master/my_contribution master`. Please avoid working directly on the `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+For details, see ["Writing good commit messages.""](https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
+
+* Make sure you have added the necessary Google tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Making Trivial Changes
+
+### Documentation
+
+For changes to how a user would run Celero from a command line or how a user might build Celero benchmarks, please provide the appropriate updates to README.md documenting the changes.  In-line code documentaiton following the Doxygen markup language should also be accomplished within the code.
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the "develop" branch of the Celero repository.
+* Update your Jira ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
+  * Include a link to the pull request in the ticket.
+* After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

README.md

@@ -1,5 +1,7 @@
 #Celero
 
+Develop Branch Status: [![Build Status](https://travis-ci.org/DigitalInBlue/Celero.svg?branch=develop)](https://travis-ci.org/DigitalInBlue/Celero)
+
 ###C++ Benchmarking Library
 
 Copyright 2015 John Farrier 

include/celero/TestFixture.h

@@ -60,6 +60,24 @@ namespace celero
 			///
 			virtual std::vector<int64_t> getExperimentValues() const { return std::vector<int64_t>(); };
 
+			///
+			/// Allows the text fixture to run code that will be executed once
+			/// immediately before the benchmark. Unlike setUp, the evaluation
+			/// of this function IS included in the total experiment execution
+			/// time.
+			///
+			/// \param experimentValue The value for the experiment.  This can be ignored if the test does not utilize experiment values.
+			///
+			virtual void onExperimentStart(int64_t experimentValue);
+
+			///
+			/// Allows the text fixture to run code that will be executed once
+			/// immediately after the benchmark. Unlike tearDown, the evaluation
+			/// of this function IS included in the total experiment execution
+			/// time.
+			///
+			virtual void onExperimentEnd();
+
 			///
 			/// Set up the test fixture before benchmark execution.
 			///

src/Executor.cpp

@@ -97,7 +97,7 @@ void executor::RunBaseline(std::shared_ptr<Benchmark> bmark)
 
 	if(baselineExperiment != nullptr)
 	{
-		// Populate the problem space with a fake test fixture instantiation.
+		// Populate the problem space with a test fixture instantiation.
 		{
 			auto testValues = baselineExperiment->getFactory()->Create()->getExperimentValues();
 			for(auto i : testValues)
@@ -148,7 +148,8 @@ void executor::Run(std::shared_ptr<Experiment> e)
 {
 	auto bmark = e->getBenchmark();
 
-	if(bmark->getBaseline()->getResult(0)->getComplete() == false)
+	auto baseline = bmark->getBaseline();
+	if(baseline->getResultSize() == 0 || baseline->getResult(0)->getComplete() == false)
 	{
 		executor::RunBaseline(bmark);
 	}
@@ -208,4 +209,4 @@ void executor::Run(const std::string& benchmarkName, const std::string& experime
 		assert(e != nullptr);
 		executor::Run(e);
 	}
-}
+}

src/Experiment.cpp

@@ -259,22 +259,13 @@ void Experiment::addProblemSpace(int64_t x)
 
 size_t Experiment::getResultSize()
 {
-	if(this->pimpl->results.empty() == true)
-	{
-		this->pimpl->results.push_back(std::make_shared<Result>(this));
-	}
-
 	return this->pimpl->results.size();
 }
 
 std::shared_ptr<Result> Experiment::getResult(size_t x)
 {
-	if((x == 0) && (this->pimpl->results.empty() == true))
-	{
-		this->pimpl->results.push_back(std::make_shared<Result>(this));
-	}
-
-	return this->pimpl->results[x];
+	// get the result OR thrown an exception if the result list is empty;
+	return this->pimpl->results.at(x);
 }
 
 std::shared_ptr<Result> Experiment::getResultByValue(int64_t x)

src/TestFixture.cpp

@@ -33,6 +33,14 @@ TestFixture::~TestFixture()
 {
 }
 
+void TestFixture::onExperimentStart(int64_t)
+{
+}
+
+void TestFixture::onExperimentEnd()
+{
+}
+
 void TestFixture::setUp(int64_t)
 {
 }
@@ -51,11 +59,15 @@ uint64_t TestFixture::run(const uint64_t calls, int64_t experimentValue)
 
 	// Get the starting time.
 	const auto startTime = celero::timer::GetSystemTime();
+
+	this->onExperimentStart(experimentValue);
 
 	while(operation--)
 	{
 		this->UserBenchmark();
 	}
+
+	this->onExperimentEnd();
 
 	const auto endTime = celero::timer::GetSystemTime();