## Overview

This directory has example usages of Intel® Threading Building Blocks (Intel® TBB).

## Directories

GettingStarted
  Examples from the Getting Started Guide.
concurrent_hash_map
  Examples using `concurrent_hash_map`.
concurrent_priority_queue
  Examples using `concurrent_priority_queue`.
graph
  Examples using `tbb::flow graph`.
parallel_do
  Examples using `parallel_do`.
parallel_for
  Examples using `parallel_for`.
parallel_reduce
  Examples using `parallel_reduce`.
pipeline
  Examples using `pipeline`.
task
  Examples using raw `task` interface.
task_group
  Examples using `task_group` interface.
task_arena
  Examples using the task priority feature.
test_all
  Examples that test all the parts of the package.
common
  Common files for building various examples. Should not be used directly. But if you copy an example to other place this folder should be copied also and should have the same relative path for copied example.

## To Build

Build each example by using one of the following methods. The specific directions for each method can be found below.

- Build by using a Microsoft* Visual Studio* project (Windows* systems only).
- Build by using a Xcode* IDE project (OS X* systems only).
- Build by using a Makefile (Windows*, Linux* or OS X* systems).

Some of the following directions refer to a shell window; this refers to the command prompt environment/window normally used on your system. A shell might be a cmd.exe command prompt window (Windows* systems), or a sh, bash, csh, ksh, etc. (or compatible) shell window (Windows*, Linux* or OS X* systems).

#### To build by using a Microsoft* Visual Studio* project (Windows* systems):

Perform the following steps:

1. Identify the solution (*.sln) file for the example you wish to build and run. For Microsoft* Visual Studio* 2010, the *.sln file is in the example's msvs sub-directory.
2. Open the project by using one of the following methods:
   - Navigate to the *.sln file from My Computer, by using Windows Explorer, or by using another file browser. Double-click the *.sln file to invoke Microsoft* Visual Studio* and open the project.
   - Invoke Microsoft* Visual Studio* from the Start menu and use the "Open Project" dialog to navigate to and open the project.
3. Press <ctrl-F5> to build and run the example.
4. If you copied an example to another place separately from libraries you need to set %TBBROOT% variable pointing to <installdir> folder.

#### To build by using a Xcode* IDE project (OS X* systems):

Perform the following steps:

1. Identify the project (*.xcodeproj) file for the example you wish to build and run.
   - The *.xcodeproj file is in the example's xcode sub-directory.
2. Open the project by using one of the following methods:
   - Navigate to the *.xcodeproj file by using the Finder.Double-click the *.xcodeproj file to invoke the Xcode* IDE and open the project.
   - Invoke the Xcode* IDE and use the "File -> Open" dialog to navigate to and open the project.
3. Press <Apple-R>, or press the "Build and Go" button in the toolbox, to build and run the example.

#### To build by using a Makefile (Windows*, Linux* or OS X* systems):

Perform the following steps:

1. Open a shell window. For Windows* systems, make sure this shell window has the proper environment defined for use with Microsoft* Visual Studio* (2005, 2008, 2010 or 2012); such a shell can be invoked from the Start menu, under Visual Studio, Visual Studio Tools, Visual Studio Command Prompt.
2. Set up the environment in this shell window for use with Intel TBB.
   See below for how to set up the environment for Windows*, Linux* or OS X* systems.
3. Unless you installed Intel TBB yourself, you may not have write permissions to the directory containing the example. In this case, make a copy of the example, and use the copy for the following steps.
4. In the shell window, navigate to the directory for the example (or to the directory for the copy of the example if you made one in the previous step).
5. Use one or more of the following commands to build and run the example. Here, make refers to the make command normally used on your system: this could be nmake, gmake, or make on Windows* systems, or make or gmake on Linux* or OS X* systems.
   `make`
     Default build and run. Equivalent to 'make release test'.
   `make release`
     Compile and link against the release version of Intel TBB runtime library. The resulting executable is left in the directory for the example.
   `make debug`
     Compile and link against the debug version of Intel TBB runtime library. The resulting executable is left in the directory for the example.
   `make test`
     Run an executable previously produced by one of the above commands.
   `make [(above options or targets)] CXX={icl, icc}`
     Build and run as above, but use Intel® compilers instead of default, native compilers (e.g., icl instead of cl.exe on Windows* systems, or icc instead of g++ on Linux* or OS X* systems).
   `make [(above options or targets)] offload=mic`
     Build and run the offload version of an example for Intel® Many Integrated Core (Intel® MIC) Architecture.
     Note: Only Intel® MIC Architecture with Linux* based host is currently supported.
   `make clean`
     Remove any executables or intermediate files produced by the above commands.

#### To set up the environment (Windows* systems):

It is strongly recommended that the environment be set up when installing Intel TBB. Do this by selecting the appropriate check-box during the install. However, if the environment is not set up during installation, or you wish to build for an alternate architecture or Microsoft* Visual Studio* version, it may be set up, for a given type of shell window, by using one of the following commands:

For cmd.exe (command prompt):
  `<installdir>\bin\tbbvars.bat (arch) (vs)`

          where (arch) must be is one of the following
             ia32         : Set up for IA-32  architecture
             intel64      : Set up for Intel® 64  architecture
         (vs) should be one of the following
             vs2010      : Set to use with Microsoft Visual Studio 2010 runtime DLLs
             vs2012      : Set to use with Microsoft Visual Studio 2012 runtime DLLs
             vs2013      : Set to use with Microsoft Visual Studio 2013 runtime DLLs
             all         : Set to use TBB statically linked with Microsoft Visual C++ runtime
         if (vs) is not set TBB statically linked with Microsoft Visual C++ runtime will be used.

#### To set up the environment (Linux* or OS X* systems):

The environment may be set up, for a given type of shell window, by using one of the following commands:

For sh, bash, ksh (or compatibles):
  . <installdir>/bin/tbbvars.sh (arch)
For csh (or compatibles):
  source <installdir>/bin/tbbvars.csh (arch)
Notes:
  <SL>
  - Choose one of {ia32,intel64} depending on the architecture to be used.
  - Environment setup need only be performed once per shell window to be used.
  - Always source tbbvars.sh or tbbvars.csh rather than executing them directly. </SL>

Up to parent directory

Copyright © 2005-2015 Intel Corporation. All Rights Reserved.

Intel is a registered trademark or trademark of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.