Skip to content

Commit a9546bd

Browse files
committed
Added License to SerializerCore; more docs
1 parent 01eb404 commit a9546bd

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

src/main/java/org/numenta/nupic/network/PersistenceAPI.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ public interface PersistenceAPI extends Serializable {
157157
*/
158158
public <R extends Persistable> R read(String fileName);
159159
/**
160-
* Loads a {@code Network} from the specified serialized byte array and
161-
* returns the de-serialized Network.
160+
* Loads a {@code Persistable} from the specified serialized byte array and
161+
* returns the de-serialized Persistable.
162162
*
163163
* @param <R> the type of the returned serialized form
164164
* @param serializedBytes the name of the serialization file.

src/main/java/org/numenta/nupic/network/SerializerCore.java

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
/* ---------------------------------------------------------------------
2+
* Numenta Platform for Intelligent Computing (NuPIC)
3+
* Copyright (C) 2016, Numenta, Inc. Unless you have an agreement
4+
* with Numenta, Inc., for a separate license for this software code, the
5+
* following terms and conditions apply:
6+
*
7+
* This program is free software: you can redistribute it and/or modify
8+
* it under the terms of the GNU Affero Public License version 3 as
9+
* published by the Free Software Foundation.
10+
*
11+
* This program is distributed in the hope that it will be useful,
12+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14+
* See the GNU Affero Public License for more details.
15+
*
16+
* You should have received a copy of the GNU Affero Public License
17+
* along with this program. If not, see http://www.gnu.org/licenses.
18+
*
19+
* http://numenta.org/licenses/
20+
* ---------------------------------------------------------------------
21+
*/
122
package org.numenta.nupic.network;
223

324
import java.io.IOException;
@@ -12,6 +33,15 @@
1233
import org.slf4j.Logger;
1334
import org.slf4j.LoggerFactory;
1435

36+
37+
/**
38+
* {@link PeristenceAPI} underbelly which uses the FST Fast Serialization library to
39+
* serialize various HTM.java object.
40+
*
41+
* @author cogmission
42+
* @see PersistenceAPI
43+
* @see SerialConfig
44+
*/
1545
public class SerializerCore implements Persistable {
1646
private static final long serialVersionUID = 1L;
1747

0 commit comments

Comments
 (0)