Add description of necessities of cost_type

This commit is contained in:
Anton Reinhard 2023-11-20 19:08:40 +01:00
parent 1e0e699e6d
commit 9d947a49ce

View File

@ -20,7 +20,7 @@ function cost_type end
"""
graph_cost(estimator::AbstractEstimator, graph::DAG)
Get the total estimated cost of the graph. The cost's data type can be chosen by the implementation, but should have usable comparison operators (<, <=, >, >=, ==) and basic math operators (+, -, *, /).
Get the total estimated cost of the graph. The cost's data type can be chosen by the implementation, but must have a usable lessthan comparison operator (<), basic math operators (+, -) and an implementation of `zero()` and `typemax()`.
"""
function graph_cost end