Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comment Spelling Fixes #232

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ if (CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
message(FATAL_ERROR
"In-source build are not allowed.
Please create a directory directory and run cmake from there, passing the path
to this source directory as the last argumente.
to this source directory as the last argument.
This process created the file `CMakeCache.txt' and the directory `CMakeFiles'.
Please delete them.")
endif()
Expand Down
2 changes: 1 addition & 1 deletion examples/blackscholes/blackscholes.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) 2007, Intel Copr.
// Copyright (c) 2007, Intel Corp.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
Expand Down
4 changes: 2 additions & 2 deletions include/shad/core/vector.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ namespace impl {
/// @brief Distributed vector without resizing capabilities.
/// TODO change the descriptions
/// The C++ standard defines the ::vector as a dynamically
/// resizeable sequence of objects. A ::vector should be a contiguous container
/// resizable sequence of objects. A ::vector should be a contiguous container
/// (as defined in the C++ standard). According to that definition, contiguous
/// containers requires contiguous iterators. The definition of contiguous
/// iterators implies contiguous memory allocation for the sequence, and it
Expand Down Expand Up @@ -852,7 +852,7 @@ class alignas(64) vector<T>::vector_iterator {
/// @brief Fixed size distributed vector.
///
/// Section XX.X.X.X of the C++ standard defines the ::vector as a dynamically
/// resizeable sequence of objects. A ::vector should be a contiguous container
/// resizable sequence of objects. A ::vector should be a contiguous container
/// (as defined in section XX.X.X). According to that definition, contiguous
/// containers requires contiguous iterators. The definition of contiguous
/// iterators implies contiguous memory allocation for the sequence, and it
Expand Down
4 changes: 2 additions & 2 deletions include/shad/data_structures/abstract_data_structure.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ namespace shad {
/// @warning Subclasses SUBC of AbstractDataStructure MUST implement the
/// constructor SUBC(ObjectID oid, Args ... args) and the GetGlobalID() method.
///
/// The inheriting class constructor can accept aribitrary memcpyable arguments
/// The inheriting class constructor can accept arbitrary memcpyable arguments
/// (args): the create method of AbstractDataStructure can be called from the
/// subclass using the same arguments (args) of the constructor. It is
/// recommended to implement the constructor as private/protected.
Expand Down Expand Up @@ -116,7 +116,7 @@ class AbstractDataStructure {
/// retrieve a valid shared_ptr via the GetPtr operation.
///
/// @param oid The global identifier of the DataStructure instance.
/// @return A shared_ptr to the DataStructure instance associared to oid.
/// @return A shared_ptr to the DataStructure instance associated to oid.
static SharedPtr GetPtr(ObjectID oid) {
return Catalog::Instance()->GetPtr(oid);
}
Expand Down
4 changes: 2 additions & 2 deletions include/shad/data_structures/array.h
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ class Array : public AbstractDataStructure<Array<T>> {

/// @brief Lookup Method.
///
/// Retireve an element at a given position.
/// Retrieve an element at a given position.
///
/// Typical usage:
/// @code
Expand All @@ -324,7 +324,7 @@ class Array : public AbstractDataStructure<Array<T>> {

/// @brief Asynchronous Lookup Method.
///
/// Retireve an element at a given position asynchronously.
/// Retrieve an element at a given position asynchronously.
///
/// @warning Asynchronous operations are guaranteed to have completed
/// only after calling the rt::waitForCompletion(rt::Handle &handle) method.
Expand Down
22 changes: 11 additions & 11 deletions include/shad/data_structures/atomic.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ namespace shad {
///
/// @warning Writes are not propagated across the system.
///
/// @tparam T The typen of the objects that will be instantiated.
/// @tparam T The type of the objects that will be instantiated.
template <typename T>
class Atomic : public AbstractDataStructure<Atomic<T>> {
public:
Expand All @@ -57,7 +57,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
static SharedPtr Create(Args... args);
#endif

/// @brief Retieve the Global Identifier.
/// @brief Retrieve the Global Identifier.
///
/// @return The global identifier associated with the array instance.
ObjectID GetGlobalID() const { return oid_; }
Expand Down Expand Up @@ -144,7 +144,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
}

/// @brief Atomic Store. Attempts at atomically storing the results of binop
/// unitil succesful.
/// until successful.
///
/// @tparam ArgT Type of rhs for the BinaryOp operator.
/// @tparam BinaryOp User-defined binary operator T (const T& lhs, const ArgT& rhs).
Expand Down Expand Up @@ -181,7 +181,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {


/// @brief Async Atomic Fetch-Store. Attempts at atomically storing
/// the results of binop unitil succesful.
/// the results of binop until successful.
///
/// @tparam ArgT Type of rhs for the BinaryOp operator.
/// @tparam BinaryOp User-defined binary operator T (const T& lhs, const ArgT& rhs).
Expand Down Expand Up @@ -272,7 +272,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
}

/// @brief Async Atomic Store. Attempts at atomically storing
/// the results of binop unitil succesful.
/// the results of binop until successful.
///
/// @tparam ArgT Type of rhs for the BinaryOp operator.
/// @tparam BinaryOp User-defined binary operator T (const T& lhs, const ArgT& rhs).
Expand Down Expand Up @@ -309,7 +309,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
}

/// @brief Async Atomic Fetch-Store. Attempts at atomically storing
/// the results of binop unitil succesful.
/// the results of binop until successful.
///
/// @tparam ArgT Type of rhs for the BinaryOp operator.
/// @tparam BinaryOp User-defined binary operator T (const T& lhs, const ArgT& rhs).
Expand Down Expand Up @@ -404,7 +404,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
/// @brief Fetch Add operation.
///
/// @param[in] add Data to be fetch-added.
/// @return Result of the fect-add operation.
/// @return Result of the fetch-add operation.
T FetchAdd(T add) {
if (ownerLoc_ == rt::thisLocality()) {
return localInstance_.fetch_add(add);
Expand Down Expand Up @@ -462,7 +462,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
/// @brief Fetch Sub operation.
///
/// @param[in] sub Data to be fetch-subbed.
/// @return Result of the fect-sub operation.
/// @return Result of the fetch-sub operation.
T FetchSub(T sub) {
if (ownerLoc_ == rt::thisLocality()) {
return localInstance_.fetch_sub(sub);
Expand Down Expand Up @@ -520,7 +520,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
/// @brief Fetch And operation.
///
/// @param[in] operand Data to be fetch-anded.
/// @return Result of the fect-and operation.
/// @return Result of the fetch-and operation.
T FetchAnd(T operand) {
if (ownerLoc_ == rt::thisLocality()) {
return localInstance_.fetch_and(operand);
Expand Down Expand Up @@ -578,7 +578,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
/// @brief Fetch Or operation.
///
/// @param[in] operand Data to be fetch-ored.
/// @return Result of the fect-or operation.
/// @return Result of the fetch-or operation.
T FetchOr(T operand) {
if (ownerLoc_ == rt::thisLocality()) {
return localInstance_.fetch_or(operand);
Expand Down Expand Up @@ -636,7 +636,7 @@ class Atomic : public AbstractDataStructure<Atomic<T>> {
/// @brief Fetch Xor operation.
///
/// @param[in] xor Data to be fetch-xored.
/// @return Result of the fect-xor operation.
/// @return Result of the fetch-xor operation.
T FetchXor(T operand) {
if (ownerLoc_ == rt::thisLocality()) {
return localInstance_.fetch_xor(operand);
Expand Down
2 changes: 1 addition & 1 deletion include/shad/data_structures/buffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ namespace impl {

/// @brief The Buffer utility.
///
/// Buffer used to agregate data transfers in insertion methods.
/// Buffer used to aggregate data transfers in insertion methods.
/// It is associated to a DataStructure instance, through its
/// global object identifier, and to the Locality target of the
/// data transfers.
Expand Down
4 changes: 2 additions & 2 deletions include/shad/data_structures/compare_and_hash_utils.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ namespace shad {
/// if (!MemCmp()(&value1, &value2)) {
/// // they are equal so do something
/// } else {
/// // do sothing different
/// // do something different
/// }
/// }
/// @endcode
Expand Down Expand Up @@ -82,7 +82,7 @@ class MemCmp {
/// if (!MemCmp()(&value1, &value2)) {
/// // they are equal so do something
/// } else {
/// // do sothing different
/// // do something different
/// }
/// }
/// @endcode
Expand Down
8 changes: 4 additions & 4 deletions include/shad/data_structures/hashmap.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class map_iterator;
/// @tparam KTYPE type of the hashmap keys.
/// @tparam VTYPE type of the hashmap values.
/// @tparam KEY_COMPARE key comparison function; default is MemCmp<KTYPE>.
/// @warning obects of type KTYPE and VTYPE need to be trivially copiable.
/// @warning objects of type KTYPE and VTYPE need to be trivially copyable.
/// @tparam INSERT_POLICY insertion policy; default is overwrite
/// (i.e. insertions overwrite previous values
/// associated to the same key, if any).
Expand Down Expand Up @@ -95,7 +95,7 @@ class Hashmap : public AbstractDataStructure<

/// @brief Create method.
///
/// Creates a newhashmap instance.
/// Creates a new hashmap instance.
/// @param numEntries Expected number of entries.
/// @return A shared pointer to the newly created hashmap instance.
#ifdef DOXYGEN_IS_RUNNING
Expand All @@ -107,7 +107,7 @@ class Hashmap : public AbstractDataStructure<
/// @return The global identifier associated with the hashmap instance.
ObjectID GetGlobalID() const { return oid_; }

/// @brief Getter of the local hasmap.
/// @brief Getter of the local hashmap.
///
/// @return The pointer to the local hashmap instance.
LocalHashmap<KTYPE, VTYPE, KEY_COMPARE, INSERT_POLICY> * GetLocalHashmap() {
Expand All @@ -116,7 +116,7 @@ class Hashmap : public AbstractDataStructure<

/// @brief Overall size of the hashmap (number of entries).
/// @warning Calling the size method may result in one-to-all
/// communication among localities to retrieve consinstent information.
/// communication among localities to retrieve consistent information.
/// @return the size of the hashmap.
size_t Size() const;

Expand Down