Skip to content

Commit

Permalink
[swig] add wrapper for LGBM_DatasetGetFeatureNames (#4103)
Browse files Browse the repository at this point in the history
  • Loading branch information
shuttie authored Apr 15, 2021
1 parent 98e5a21 commit 434573e
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions swig/StringArray_API_extensions.i
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,44 @@

return strings.release();
}


/**
* @brief Wraps LGBM_DatasetGetFeatureNames. Has the same limitations as a
* LGBM_BoosterGetFeatureNames:
*
* Allocates a new StringArray. You must free it yourself if it succeeds.
* @see StringArrayHandle_free().
* In case of failure such resource is freed and nullptr is returned.
* Check for that case with null (lightgbmlib) or 0 (lightgbmlibJNI).
*
* @param handle Booster handle
* @return StringArrayHandle with the feature names (or nullptr in case of error)
*/
StringArrayHandle LGBM_DatasetGetFeatureNamesSWIG(BoosterHandle handle)
{
int num_features;
size_t max_feature_name_size;
std::unique_ptr<StringArray> strings(nullptr);

// Retrieve required allocation space:
API_OK_OR_NULL(LGBM_DatasetGetFeatureNames(handle,
0, &num_features,
0, &max_feature_name_size,
nullptr));
try {
strings.reset(new StringArray(num_features, max_feature_name_size));
} catch (std::bad_alloc &e) {
LGBM_SetLastError("Failure to allocate memory.");
return nullptr;
}

API_OK_OR_NULL(LGBM_DatasetGetFeatureNames(handle,
num_features, &num_features,
max_feature_name_size, &max_feature_name_size,
strings->data()));

return strings.release();
}

%}

0 comments on commit 434573e

Please sign in to comment.