Kernel.h File Reference

this file provide Kernel class More...

#include <memory>
#include "kids/DataSet.h"
#include "kids/Param.h"
#include "kids/RuleSet.h"
#include "kids/Status.h"

Include dependency graph for Kernel.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PROJECT_NS::Kernel
	this class provides the container and implementation of algorithms More...

Namespaces
namespace	PROJECT_NS
	< http://warp.povusers.org/FunctionParser/fparser.html

Detailed Description

this file provide Kernel class

Kernal is one of the most important classes in KIDS, and is responsible for the implementment of algorithms and functionalities

Easier interfaces for getting parameters (@todo)

• Dependencies: Param & DataSet. The parameters are passed by Param class. It is also free of storage of data, which is mapped to DataSet class.
• It's a (hierarchical) tree structure, each kernal also consists of a list of other kernels.
• The detailed algorithms can be realized in itself or its child. In priciple, we don't recomment multilevel inheritance. (please use final keyword).
• There should be no new or delete in Kernel and its derivatives! Be clear that there are three types attributes for members in Kernel: [TODO] a) external: means only need kernel's pointer points to correct object. b) shared: means kernel's pointer points to correct object and takes ownership. c) internal: means a non-pointer data type which is not exposed to public domain.

Author

Xin He

Date

2024-03

Version

1.0

Copyright

GNU Lesser General Public License (LGPL)

         Copyright (c) 2024 Xin He, Liu-Group

This software is a product of Xin's PhD research conducted by Professor Liu's Group at the College of Chemistry and Molecular Engineering, Peking University. All rights are reserved by Peking University. You should have received a copy of the GNU Lesser General Public License along with this software. If not, see https://www.gnu.org/licenses/lgpl-3.0.en.html

[logs]:

Date	Description
2024-04-14	Update the file.

Definition in file Kernel.h.