En caso de que existan tipos de terceros expuestos en la API de mi biblioteca C++

Question

Estoy desarrollando una biblioteca C++ donde el usuario proporcionará entradas complejas, como matrices y cuaterniones. No quiero tener que volver a implementar estos tipos, así que, internamente, usaré la biblioteca Eigen.

Estoy tratando de decidir sobre la mejor manera de exponer estos tipos a los clientes de mis bibliotecas ' y he encontrado algunas opciones para mi API. Utilizo un tipo quaternion como ejemplo, pero esto podría aplicarse por igual a matrices y demás. Además, aunque estoy hablando específicamente de exponer los tipos de Eigen, supongo que esta pregunta puede aplicarse igualmente a otras bibliotecas externas en uso.

1) el uso de C++ sólo los tipos básicos

Esta opción requeriría clientes para pasar los datos a través de los tipos básicos. Para ejemplo, para pasar en un cuaternión (4 elementos), se podría hacer:

void my_func(double my_quat[4]) 

2) Exponer Tipos de Eigen

Eigen proporciona varios tipos de plantilla para matrices y cuaterniones. Para ejemplo, si una función requiere un cuaternión, que podría utilizar de Eigen Quaterniond tipo (que en realidad es un typedef para Quaternion<double>):

void my_func(const Eigen::Quaterniond& my_quat) 

3) Crear un contenedor simple para los diferentes tipos de clientes

que podría crear un tipo muy simple cuaternión (por ejemplo, algún tipo de estructura sencilla) que clientes tendrían que crear (tal vez a través de algún tipo de función de fábrica) para pase a mi API:

void my_func(const quaternion_t& my_quat) 

Mi biblioteca podría convertir el tipo quaternion_t en mi Eigen representación interna.

No me gusta la opción 1 demasiado porque quiero que haya un sentido más fuerte de escribiendo en mis API. La opción 2 requeriría que mis clientes también usaran Eigen, no para mencionar posibles problemas de compatibilidad si usaran una versión diferente de Eigen (dicho sea de paso, Eigen es una biblioteca de solo encabezado si importa eso ). Eso deja la opción 3.

¿Qué piensa la gente? ¿Básicamente respondí mi propia pregunta? ¿Hay algún ejemplo por ahí?

preguntas relacionadas

Una cuestión relacionada se le pidió here pero realmente no entró en detalles de si se debe exponer tipos externos.

Answer 1

Envolver/encapsular. Supongamos que desea agregar alguna característica adicional, como el almacenamiento en caché del resultado de un cálculo, como la norma de un cuaternión, como un cambio de implementación.No puede hacer eso (tan fácilmente) si expone los tipos de terceros sin forzar a su código de cliente a cambiar su llamada.

Answer 2

La exposición de las bibliotecas de terceros es la más fácil a corto plazo, pero es probable que te muerda por la espalda a largo plazo. Lo más fácil, porque los tipos están ahí por lo general, no es necesario que inventes el tuyo. Te morderá si quieres usar una biblioteca de implementación diferente en el futuro, o si deseas permitir la expansión de los datos que el cliente te transfiere.

Usar solo tipos básicos es casi como crear uno propio, pero es mucho más bajo, sin una buena razón. Sus usuarios tendrán dificultades para usar su biblioteca sin consultar constantemente la documentación sobre qué es qué.

Usar sus propios tipos es la mejor opción si desea flexibilidad en la línea. Puede parecer mucho trabajo por adelantado, ya que necesita volver a crear todos los tipos existentes, pero si le da algunos consejos, puede encontrar que si usa tipos ligeramente diferentes en la interfaz de su biblioteca, facilitará la implementación. cambia mejor después.

Así que la respuesta realmente depende de sus objetivos y planes/predicciones a largo plazo: si no se ve a sí mismo cambiando de su implementación actual, puede volver a usar los tipos existentes, pero si prevé/cambio de plan en el futuro, debe crear su propia interfaz independiente.