Skip to content

LatticeTiling: add XLALSetLatticeTilingPadding()

Karl Wette requested to merge ANU-CGA/lalsuite:lattice-tiling-padding into master

Description

The LatticeTiling module has various options for setting how much extra padding is added to parameter space boundaries to cover the edges. Currently these are controlled by the functions XLAL{Set|Add}LatticeTilingPaddingFlags() which allows the user to select from some fixed options.

This MR replaces those functions with a new function XLALSetLatticeTilingPadding() which gives more flexibility as to how these options are set.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

The new interface is needed to give greater control over the LatticeTiling padding behaviour for certain uses. This is a pretty specialised feature and is unlikely to be used by downstream dependencies. The next release of LALSuite will probably be a full release, so introducing a backward-incompatible change now will hopefully not be too disruptive.

Review Status

N/A

Merge request reports