Skip to content

CodeStyle

Andrey Prokopenko edited this page Oct 1, 2020 · 8 revisions

ArborX code style

The following code style was adopted in ArborX:

  • Code format from .clang-format (with clang-7)
  • Camel case template parameters (NewTemplateType)
  • Camel case class names (NewClassName)
  • Lower camel case function names (newFunctionName)
  • Lower case, underscore separated variables (variable_name)
  • Class members which are private are preceeded by an underscore (_private_class_variable)
  • Class/struct member type aliases use lower case, underscore separated names (using node_type = Node;)
  • Kokkos profiling regions, parallel regions, and views labels
    • ArborX::ClassName::view_label for class member views
    • ArborX::ClassName::function::label for local views, profiling regions and parallel regions in class member functions
    • ArborX::function::label or ArborX::functional_area::label everywhere else